Skip to content
digizeDocs

What can be sent

GET
/api/v1/messaging/channels
curl --request GET \
  --url https://digize.com/api/v1/messaging/channels \
  --header 'x-api-key: <x-api-key>'

Whether texts can go out (Twilio connected with a number that texts) and email (only from a sending domain), and why not.

Needs the crm:read permission.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Done

Media typeapplication/json
object
sms
required
object
twilio
required

Sends_only: connected with an API key, so texts and calls can’t come in.

string
Allowed values: connected sends_only not_connected
account
required
string | null
numbers
required
Array<object>
object
id
required

Twilio’s SID for it.

string
number
required

In E.164, such as +15125550142.

string
label
required
string
ringsTo
required

The members whose phones calls to it ring, by user id.

Array<string>
sms
required
boolean
voice
required
boolean
ready
required
boolean
problem
required
string | null
email
required
object
ready
required

Whether the workspace can email its customers: only from a sending domain, never from a Digize address.

boolean
from
required
string | null
problem
required
string | null

Example 

{
  "sms": {
    "twilio": "connected"
  }
}

400

Section titled “400”

What was sent isn’t valid (invalid).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

401

Section titled “401”

No key, or one that’s unknown, off or expired.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

403

Section titled “403”

The key doesn’t have the permission this needs.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

404

Section titled “404”

Nothing has that id (not_found).

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}

429

Section titled “429”

Over the rate limit; see retry-after.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal
message
required
string
details
object
key
additional properties
any

Example 

{
  "error": {
    "code": "invalid"
  }
}