Skip to main content
API docs by Redocly

courier API definition (1.0.0)

courier API definition

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "aggregation-requests"
required
object
required
Array of objects
Array
column
required
string <= 64 characters
individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/announcers

Returns announcers

Returns announcers

query Parameters
filter[name]
string <= 255 characters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new announcer

Creates a new announcer

Request Body schema: application/json
required
object
type
required
string
Value: "announcers"
required
object
args
required
object
event
required
string
Enum: "individual-shared" "individual-unshared"
name
required
string <= 255 characters
type
required
string <= 255 characters
organization-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an announcer

Deletes an announcer

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific announcer

Returns specific announcer

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing announcer

Modifies an existing announcer

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "announcers"
required
object
args
object
event
string
Enum: "individual-shared" "individual-unshared"
name
string <= 255 characters
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials

/v1/app-credentials/

query Parameters
filter[app-name]
string <= 64 characters
filter[type]
string
Enum: "apn" "fcm"
include[archived]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/app-credentials/

Request Body schema: application/json
required
object
type
required
string
Value: "app-credentials"
required
object
app-name
required
string <= 64 characters
data
required
object
type
required
string
Enum: "apn" "fcm"
display-name
string <= 255 characters
organization-id
string <uuid>
store-id
string <= 255 characters
test-mode
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "app-credentials"
required
object
app-name
string <= 64 characters
archived
boolean
data
object
display-name
string <= 255 characters
organization-id
string <uuid>
store-id
string <= 255 characters
test-mode
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/badge-counts

/v1/badge-counts/

query Parameters
individual-id
required
string <uuid>
organization-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/badge-counts/

Request Body schema: application/json
required
object
type
required
string
Value: "badge-counts"
required
object
count
required
integer
individual-id
required
string <uuid>
type
required
string
Enum: "appointment" "article" "survey" "todo" "todo-self"
organization-id
string <uuid>
timestamp
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/badge-counts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/bulk-badge-counts

/v1/bulk-badge-counts/

Request Body schema: application/json
required
object
type
required
string
Value: "bulk-badge-counts"
required
object
required
Array of objects [ 1 .. 10000 ] items
Array ([ 1 .. 10000 ] items)
count
required
integer
individual-id
required
string <uuid>
type
required
string
Enum: "appointment" "article" "survey" "todo" "todo-self"
organization-id
string <uuid>
timestamp
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/communication-messages

/v1/communication-messages/

query Parameters
filter[archived]
boolean
filter[bookmarked]
boolean

If any bookmark exists for the channel

filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against channel last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[individual-group-id]
string <uuid>
filter[text]
string <= 512 characters
filter[type]
string
Enum: "direct-message" "group-message" "multicast" "none" "open" "simple" "single"
individual-id
string <uuid>
organization-id
string <uuid>
page[limit]
integer [ 1 .. 100 ]
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Items Enum: "-ack-timestamp" "-has-unread" "-last-timestamp" "-unread-count" "ack-timestamp" "has-unread" "last-timestamp" "unread-count"
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/communication-summaries

/v1/communication-summaries/

query Parameters
include-sender-id
string <uuid>
include-senders
boolean
Deprecated
Default: false

Include a mapping of individual-id to counts

individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "summary": {
    }
}

/v1/email-addresses

/v1/email-addresses/

query Parameters
filter[email]
string <email>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/email-addresses/

Request Body schema: application/json
required
object
type
required
string
Value: "email-addresses"
required
object
email
required
string <email>
unsubscribed-mode
string
Enum: "all" "none"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/email-addresses/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/email-addresses/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "email-addresses"
required
object
unsubscribed-mode
string
Enum: "all" "none"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/email-addresses/{id}/unsubscribe/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{ }

/v1/individual-groups

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals

/v1/individuals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals/{id}/multicast/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
template-data
required
object
template-id
required
string <= 255 characters
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "template-data": { },
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "8ff7a72a-ed49-4045-9aa2-840c122868e0"
}

/v1/individuals/{id}/recalculate-communication-summary/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments

/v1/messaging-attachments/

query Parameters
message-id
required
string <uuid>
filter[include-pending]
boolean
Default: false
individual-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-attachments"
required
object
content-type
required
string
Enum: "application/msword" "application/pdf" "application/vnd.ms-excel" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "audio/mpeg" "audio/ogg" "audio/x-wav" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp" "text/csv" "video/3gpp" "video/mp4" "video/mpeg" "video/quicktime" "video/webm" "video/x-m4v" "video/x-msvideo"
message-id
required
string <uuid>
filename
string <= 255 characters
Default: ""
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Deletes a message attachment

Deletes a message attachment

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-attachments/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-attachments"
required
object
removed
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/messaging-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bookmarks

/v1/messaging-bookmarks/

query Parameters
organization-id
required
string <uuid>
filter[channel-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-bookmarks/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bookmarks"
required
object
allow-multi-message
boolean
Default: false
channel-id
string <uuid>
message-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bookmarks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bookmarks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-attachments

/v1/messaging-bulk-attachments/

query Parameters
bulk-message-id
required
string <uuid>
filter[include-pending]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-bulk-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-attachments"
required
object
bulk-message-id
required
string <uuid>
content-type
required
string
Enum: "application/msword" "application/pdf" "application/vnd.ms-excel" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "audio/mpeg" "audio/ogg" "audio/x-wav" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp" "text/csv" "video/3gpp" "video/mp4" "video/mpeg" "video/quicktime" "video/webm" "video/x-m4v" "video/x-msvideo"
filename
string <= 255 characters
Default: ""
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/messaging-bulk-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bulk-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-attachments/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/messaging-bulk-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages

/v1/messaging-bulk-messages/

query Parameters
filter[created-by]
string <uuid>
include-posted
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Posts a new message to many channels

Posts a new message to many channels

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-messages"
required
object or object
Any of
individual-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
sender-individual-group-id
required
string <uuid>
sender-individual-id
required
string <uuid>
auto-ack
string
Enum: "" "all" "participants" "providers" "sender"
auto-create-channel
boolean
Default: true
draft
boolean
Default: false
individual-group-ids
Array of strings <uuid> [ items <uuid > ]
message
string <= 99999 characters
object
en_US
required
string <= 99999 characters
es_US
required
string <= 99999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-messages"
required
object
draft
boolean
message
string <= 99999 characters
object
en_US
required
string <= 99999 characters
es_US
required
string <= 99999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channel-logs

/v1/messaging-channel-logs/

query Parameters
channel-id
required
string <uuid>
filter[event]
string
Enum: "follow" "unread"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-channel-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channels

Returns channels

Returns channels

query Parameters
filter[archived]
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against channel last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[floating]
boolean
filter[individual-group-id]
string <uuid>
individual-id
string <uuid>
organization-id
string <uuid>
page[limit]
integer [ 1 .. 50 ]
Default: 50
page[offset]
integer (PageOffset) >= 0
Default: 0
participant-id
string <uuid>
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
object
object
enabled
boolean
floating
boolean
Deprecated
Default: true
individual-group-id
string <uuid>
individual-ids
Array of strings <uuid> [ items <uuid > ]
label
string <= 255 characters
name
string <= 128 characters
organization-id
string <uuid>
subscription-type
string
Default: "open"
Enum: "none" "open" "simple" "single"
text-number-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a channel

Deletes a channel

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
include-individual-group
boolean
Deprecated
Default: false
individual-id
string <uuid>
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channels/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

Modifies an existing channel

Modifies an existing channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
Array of objects or objects
Array
Any of
op
required
string
Value: "replace"
path
required
string <= 255 characters
value
required
any
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Archive a channel

Archive a channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channels/{id}/get-profile/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>

users operational individual-id

profile-individual-id
required
string <uuid>

individual-id for requested profile

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/messaging-channels/{id}/provider-ack/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

Modify channel preferences

Modify channel preferences

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
Array of objects
Array
name
required
string
Value: "notify"
value
string <= 255 characters
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "values": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Enable/disable SMS path for this messaging channel

Enable/disable SMS path for this messaging channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
active
required
boolean
initial-message
string <= 1024 characters
object
en_US
required
string <= 1024 characters
es_US
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "initial-message": "string",
  • "initial-message-js": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Add subscriber to the channel

Add subscriber to the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Unarchive a channel

Unarchive a channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Remove subscriber from the channel

Remove subscriber from the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-messages

Returns messages in specified group, posted by spe

Returns messages in specified group, posted by specified user, and belonging to specified subscription.

query Parameters
channel-id
required
string <uuid>
acknowledged
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against message last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[cmp-posted-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against message posted-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[text]
string <= 255 characters
include-phrases
boolean
Default: false
include-read-receipts
boolean
Default: false
individual-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
thumbnail
boolean
Default: false
user-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Posts a new message

Posts a new message

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
channel-id
required
string <uuid>
message
required
string <= 99999 characters
auto-ack
string
Enum: "" "all" "participants" "providers" "sender"
draft
boolean
Default: false
include-destinations
Array of strings[ items <= 16 characters ]
individual-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a message

Deletes a message

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns a single message from the given id

Returns a single message from the given id

path Parameters
id
required
string

Resource identifier

query Parameters
include-phrases
boolean
Default: false
individual-id
string <uuid>
thumbnail
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-messages/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
null

Modifies an existing message

Modifies an existing message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
draft
boolean
individual-id
string <uuid>
Deprecated
message
string <= 99999 characters
removed
boolean
todo-entry-id
string <uuid>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Acknowledge a message, and all messages before thi

Acknowledge a message, and all messages before this

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
allow-past
boolean
Default: false
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "allow-past": false,
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

add a user-reaction to a message

add a user-reaction to a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "reaction-type": "dislike"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

delete a user-reaction from a message

delete a user-reaction from a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "reaction-type": "dislike"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

get receipts of this message

get receipts of this message

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "read": [
    ],
  • "unread": [
    ]
}

/v1/messaging-operations

/v1/messaging-operations/

query Parameters
organization-id
required
string <uuid>
filter[type]
string
Value: "move-group"
include-args
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-operations/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-operations"
required
object
args
required
object
organization-id
required
string <uuid>
type
required
string
Value: "move-group"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-operations/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-args
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins

/v1/messaging-plugins/

query Parameters
organization-id
required
string <uuid>
filter[name]
string [ 4 .. 15 ] characters ^[a-z0-9]+$
filter[type]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-plugins/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-plugins"
required
object
args
required
object
name
required
string [ 4 .. 15 ] characters ^[a-z0-9]+$
organization-id
required
string <uuid>
type
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-plugins"
required
object
args
object
name
string [ 4 .. 15 ] characters ^[a-z0-9]+$
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/disable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/enable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/expand/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
channel-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "channel-id": "c67724bb-936a-4262-9e14-6e97cb4b5f2f"
}

Response samples

Content type
application/vnd.api+json
{
  • "message": "string"
}

/v1/messaging-responders

/v1/messaging-responders/

query Parameters
organization-id
required
string <uuid>
filter[cmp-end-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against end-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame. Append ,null to include null values.

filter[cmp-start-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against start-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame. Append ,null to include null values.

filter[enabled]
boolean
filter[individual-group-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Default: "created-at"
Items Enum: "-created-at" "-end-at" "-start-at" "created-at" "end-at" "start-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-responders/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-responders"
required
object
args
required
object
required
object
required
Array of objects
timezone
required
string <timezone>
name
required
string <= 255 characters
organization-id
required
string <uuid>
type
required
string <= 255 characters
end-at
string <datetime>
individual-group-id
string <uuid>
start-at
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-responders"
required
object
args
object
object
required
Array of objects
timezone
required
string <timezone>
null or string
One of
null
individual-group-id
string <uuid>
name
string <= 255 characters
null or string
One of
null
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/disable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/enable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/multicasts

/v1/multicasts/

query Parameters
filter[cmp-created-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against multicast created-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

include-individual-group
boolean
Default: false
include-individual-ids
boolean
Default: false
individual-group-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
template-id
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/multicasts/

Request Body schema: application/json
required
object
type
required
string
Value: "multicasts"
required
object or object or object
Any of
filter-type
required
string
Enum: "all-participants" "all-users"
data
object
filter-value
object
organization-id
string <uuid>
template-id
string
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/multicasts/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-individual-group
boolean
Default: false
include-individual-ids
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/org-preferences

/v1/org-preferences/

query Parameters
organization-id
required
string <uuid>
filter[name]
string
Enum: "channel-mode" "default-channel-title" "group-provider-ack" "initial-sms-message" "voice-survey"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/org-preferences/

Request Body schema: application/json
required
object
type
required
string
Value: "org-preferences"
required
object
name
required
string
Enum: "channel-mode" "default-channel-title" "group-provider-ack" "initial-sms-message" "voice-survey"
organization-id
required
string <uuid>
type
string
Default: "string"
Enum: "json" "string"
value
string <= 255 characters
value-js
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/org-preferences/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organizations

/v1/organizations/

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "test_data" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers

/v1/text-account-numbers/

query Parameters
account-id
string <uuid>
filter[phone-number]
string <phonenumberE164>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
phone-number
string <phonenumberE164>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-account-numbers/

Request Body schema: application/json
required
object
type
required
string
Value: "text-account-numbers"
required
object
account-id
required
string <uuid>
alert
boolean
Default: true
area-code
string <= 3 characters ^\d\d\d$
forward-to
string <phonenumberE164_us>
logging
boolean
Default: false
notes
string <= 255 characters
phone-number
string <phonenumberE164>
phone-number-from-main-account
string <phonenumberE164>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "text-account-numbers"
required
object
alert
boolean
object
unknown-number
object
forward-to
string <= 16 characters
logging
boolean
notes
string <= 255 characters
twilio-advanced-optout-enabled
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/reset-logs/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts

/v1/text-accounts/

query Parameters
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "text-accounts"
required
object
organization-id
required
string <uuid>
allow-custom-number
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "text-accounts"
required
object
allow-custom-number
boolean
phone-number
string <phonenumberE164_us>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/claim-number/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
notes
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "notes": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-info

/v1/text-number-info/

query Parameters
number
required
string <phonenumberE164_us>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-number-info/

Request Body schema: application/json
required
object
type
required
string
Value: "text-number-info"
required
object
number
required
string <phonenumberE164_us>
reresolve
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-info/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-number-info/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-logs

/v1/text-number-logs/

query Parameters
number-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-number-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-receive-logs

/v1/text-receive-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-receivers

/v1/text-receivers/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/text-user-number-maps

/v1/text-user-number-maps/

query Parameters
filter[number-id]
string <uuid>
filter[organization-id]
string <uuid>
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-user-number-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "text-user-number-maps"
required
object
number-id
required
string <uuid>
organization-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-user-number-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-user-number-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts

/v1/texts/

query Parameters
account-id
required
string <uuid>
filter[number-id]
string <uuid>
filter[target]
string <phonenumberE164>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/texts/

Request Body schema: application/json
required
object
type
required
string
Value: "texts"
required
object
message
required
string <= 1600 characters
target
required
string <phonenumberE164>
account-id
string <uuid>
callback-json
object
callback-one-off
boolean
Default: true
callback-status-url
string <url>
callback-url
string <url>
expected-responses
Array of strings[ items <= 64 characters ]
number-id
string <uuid>
organization-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts/{id}/callback/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/tts-synthesizers

/v1/tts-synthesizers/

Request Body schema: application/json
required
object
type
required
string
Value: "tts-synthesizers"
required
object
locale
required
string
Enum: "en-US" "es-US"
text
required
string [ 1 .. 2500 ] characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-consents

/v1/user-consents/

query Parameters
filter[organization-id]
string <uuid>
filter[user-id]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-consents/

Request Body schema: application/json
required
object
type
required
string
Value: "user-consents"
required
object
organization-id
required
string <uuid>
user-id
required
string <uuid>
object
Any of
required
object
accept
required
string
initial
required
string
invalid-response
required
string
type
string
Default: "sms"
Value: "sms"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-consents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-consents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-devices

/v1/user-devices/

query Parameters
all-users
boolean
Default: false
filter[app-name]
string <= 64 characters
filter[app-version]
string <= 20 characters
filter[individual-id]
string <uuid>
filter[model]
string <= 64 characters
filter[type]
string
Enum: "apn" "fcm" "web"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
token
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-devices/

Request Body schema: application/json
required
object
type
required
string
Value: "user-devices"
required
object
token
required
string <= 255 characters
type
required
string
Enum: "apn" "fcm" "web"
allow-notification
boolean
app-name
string <= 64 characters
app-version
string <= 20 characters
individual-id
string <uuid>
model
string <= 64 characters
os-version
string <= 20 characters
sandbox
boolean
Default: false
topic
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-devices/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-devices/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-email-attachments

/v1/user-email-attachments/

query Parameters
email-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-email-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "user-email-attachments"
required
object
content-type
required
string <= 255 characters
email-id
required
string <uuid>
filename
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/user-email-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-email-attachments/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-email-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails

/v1/user-emails/

query Parameters
individual-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-emails/

Request Body schema: application/json
required
object
type
required
string
Value: "user-emails"
required
object
message
required
string <= 99999 characters
subject
required
string <= 255 characters
auto-send
boolean
Default: true
individual-id
string <uuid>
message-html
string <= 99999 characters
sender-organization-id
string <uuid>
string or Array of strings
Any of
string <email>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails/{id}/send/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-multicasts

/v1/user-multicasts/

query Parameters
individual-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-multicasts/

Request Body schema: application/json
template-data
required
object
template-id
required
string <= 255 characters
individual-group-ids
Array of strings <uuid> non-empty [ items <uuid > ]
individual-ids
Array of strings <uuid> non-empty [ items <uuid > ]
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-group-ids": [
    ],
  • "individual-ids": [
    ],
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "template-data": { },
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "8ff7a72a-ed49-4045-9aa2-840c122868e0"
}

/v1/user-notification-counts

/v1/user-notification-counts/

query Parameters
filter[cmp-created-at]
Array of strings <= 2 items [ items <= 40 characters ]

compare timestamp against notification created_at time. specify [comparator][datetime]. comparators supported <=, >=use multiple to build a bounded time frame.

page[limit]
integer [ 0 .. 1000 ]
Default: 500
page[offset]
integer >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-notifications

/v1/user-notifications/

query Parameters
acknowledged
boolean
filter[category]
string <= 32 characters
include[inactive]
boolean
Default: false
individual-id
string <uuid>
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-notifications/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-notifications/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-notifications/{id}/ack/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
ack-previous
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "ack-previous": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users

/v1/users/

query Parameters
filter[email]
string <email>
filter[individual-id]
string <uuid>
filter[username]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "users"
required
object
notifications
Array of strings
Items Enum: "email" "mobile" "sms" "web"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/multicast/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
template-id
required
string <= 255 characters
data
object
individual-id
string <uuid>
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "8ff7a72a-ed49-4045-9aa2-840c122868e0"
}

/v1/users/{id}/validate-multicast-params/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
data
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
template-id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "organization-id": "884b39d6-2921-4a2e-a4db-914267f75c54",
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "info": "string",
  • "success": true
}

/v1/video-channels

Returns channels

Returns channels

query Parameters
individual-id
required
string <uuid>
filter[states]
Array of strings
Items Enum: "open" "scheduled" "terminated"
organization-id
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "video-channels"
required
object
organization-id
required
string <uuid>
participants
required
Array of strings <uuid> [ items <uuid > ]
appless
boolean
Default: false
object
duration
required
integer

minutes

id
required
string <uuid>
start
required
string <datetime>
messaging-channel-id
string <uuid>
recorded
boolean
Default: false
subject-id
string <uuid>
type
string
Default: "direct"
Value: "direct"
with-email
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a channel

Deletes a channel

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing video-channel

Modifies an existing video-channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "video-channels"
required
object
appointment-duration
integer

minutes

appointment-start
string <datetime>
note
string <= 99999 characters
recorded
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/video-channels/{id}/finalize-encounter/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
service-type-id
string <uuid>
use-note-from-author-participant
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "service-type-id": "63dc46e8-3df8-4212-9a73-952546fcc8ae",
  • "use-note-from-author-participant": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/get-credentials/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string",
  • "name": "string"
}

/v1/video-channels/{id}/participant-audio-states/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
Array of objects
Array
audio-state
required
string
Enum: "muted" "unmuted"
id
required
string <uuid>
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "89cd2907-789f-4760-a83f-39e6a6ed819a",
  • "participants": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/reminder-timer/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/terminate/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-compositions

/v1/video-compositions/

query Parameters
video-channel-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/video-compositions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/video-compositions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-compositions/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/video-participants

Returns participants

Returns participants

query Parameters
individual-id
required
string <uuid>
page[limit]
required
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
required
integer (PageOffset) >= 0
Default: 0
video-channel-id
required
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Returns specific participant

Returns specific participant

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modify participant

Modify participant

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "video-participants"
required
object
audio-state
string
Enum: "muted" "unmuted"
disconnected
boolean

To track user's intended state

note
string <= 99999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-calls

/v1/voice-calls/

query Parameters
setting-id
required
string <uuid>
filter[from-user-id]
string <uuid>
filter[to-user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-calls/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-client-activities

/v1/voice-client-activities/

query Parameters
setting-id
required
string <uuid>
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-client-activities/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-client-activities"
required
object
name
required
string <= 255 characters
setting-id
required
string <uuid>
client-state
string
Default: "unavailable"
Enum: "available" "unavailable"
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
ui-order
integer [ 0 .. 255 ]
Default: 0
ui-selectable
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-client-activities/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-client-activities/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-client-activities/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-client-activities"
required
object
client-state
string
Enum: "available" "unavailable"
object (LocaleStrings)
en_US
required
string <= 512 characters
es_US
required
string <= 512 characters
name
string <= 255 characters
ui-order
integer [ 0 .. 255 ]
ui-selectable
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-chunks

/v1/voice-conference-chunks/

query Parameters
file-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conference-chunks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-chunks/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-conference-events

/v1/voice-conference-events/

query Parameters
conference-id
required
string <uuid>
filter[timestamp][gt]
string <datetime>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conference-events/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-files

/v1/voice-conference-files/

query Parameters
conference-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conference-files/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conference-files"
required
object
conference-id
required
string <uuid>
timestamp
string <datetime>
type
string <= 255 characters
Default: "application/octet-stream"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-files/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-conference-files/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-files/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conference-files"
required
object
timestamp
string <datetime>
type
string <= 255 characters
Default: "application/octet-stream"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-files/{id}/download/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "download-url": "string"
}

/v1/voice-conference-files/{id}/upload-chunk/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
index
required
integer

Sequence index ID of the chunk

last-chunk
boolean

Whether this is the last chunk of the file stream

Responses

Request samples

Content type
application/json
{
  • "index": 0,
  • "last-chunk": true
}

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/voice-conference-participants

/v1/voice-conference-participants/

query Parameters
conference-id
string <uuid>
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
setting-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conference-participants/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conference-participants"
required
object
conference-id
required
string <uuid>
external-id
string <= 255 characters
extra-digits
string <= 64 characters
mute
boolean
Default: false
phone-number
string <phonenumberE164_us>
transfer-mode
string
Default: "warm"
Enum: "" "cold" "warm"
use-user-phone
boolean
Default: false
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-participants/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-conference-participants/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conference-participants/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conference-participants"
required
object
external-id
string <= 255 characters
hold
boolean
muted
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences

/v1/voice-conferences/

query Parameters
setting-id
required
string <uuid>
filter[caller-id]
string <uuid>
filter[individual-id]
string <uuid>
filter[phone-number]
string <phonenumberE164_us>
filter[states]
Array of strings
Items Enum: "completed" "created" "failed" "in-progress"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conferences/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conferences"
required
object
auto-accept
boolean

Should Beacon auto-accept the caller-side of the conference? It is an error to specify an auto-accept value for a participant unless it is for current user.

caller-id
string <uuid>

Caller user-id

caller-jitter-buffer-size
string
Enum: "large" "medium" "off" "small"

experimental

context-external-id
string <= 255 characters

opaque context-external-id for client use. e.g. hms workflow-id

context-extras
object

additional context extras

extra-digits
string <= 64 characters
individual-id
string <uuid>

target participant individual-id

organization-id
string <uuid>
Deprecated
outgoing-number
string <= 200 characters

Outgoing phone-number alias to use for the call

participant-target-external-id
string <= 255 characters

opaque target participant external-id for client use. e.g. hms UPI

phone-number
string <phonenumberE164_us>

target phone-number. Must provide one of phone-number, individual-id, or provider-id

provider-id
string <uuid>

target provider user-id

setting-id
string <uuid>
survey-id
string <uuid>
transcribe
boolean
Default: true
use-caller-phone
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-device-client-activity-logs

/v1/voice-device-client-activity-logs/

query Parameters
device-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-device-client-activity-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices

/v1/voice-devices/

query Parameters
setting-id
required
string <uuid>
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-devices/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-devices"
required
object
setting-id
required
string <uuid>
user-id
required
string <uuid>
object (JsBeacon)

Optional Beacon client information for compatibility checks

channel
required
string
Enum: "canary" "dev" "stable"

Release channel of client

version
required
string <= 64 characters ^\d+\.\d+\.\d+([+-].*)?$

Semantic version number, e.g. '0.1.10'

conference-id
string <uuid>

Active Conference ID if client is in a call

client-activity-id
string <uuid>
client-state
string
Enum: "available" "unavailable"
max-token-ttl
integer [ 60 .. 3600 ]

Advisory maximum TTL (in seconds) for the generated token. Only useful for debugging, as the default token TTL is longer than any value that may be set with this parameter.

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-devices"
required
object
client-activity-id
string <uuid>
client-state
string
Enum: "available" "unavailable"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices/{id}/check-in/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices/{id}/check-out/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
logged-out
boolean

Responses

Request samples

Content type
application/json
{
  • "logged-out": true
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-devices/{id}/refresh-token/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object (JsBeacon)

Optional Beacon client information for compatibility checks

channel
required
string
Enum: "canary" "dev" "stable"

Release channel of client

version
required
string <= 64 characters ^\d+\.\d+\.\d+([+-].*)?$

Semantic version number, e.g. '0.1.10'

conference-id
string <uuid>

Active Conference ID if client is in a call

max-token-ttl
integer [ 60 .. 3600 ]

Advisory maximum TTL (in seconds) for the generated token. Only useful for debugging, as the default token TTL is longer than any value that may be set with this parameter.

Responses

Request samples

Content type
application/json
{
  • "beacon": {
    },
  • "max-token-ttl": 60
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flow-events

/v1/voice-flow-events/

query Parameters
flow-id
required
string <uuid>
filter[execution-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-flow-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flow-executions

/v1/voice-flow-executions/

query Parameters
flow-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-flow-executions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows

/v1/voice-flows/

query Parameters
setting-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-flows/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-flows"
required
New Flow (object) or Import from Twilio (object)
Any of
name
required
string <= 255 characters
setting-id
required
string <uuid>
definition
object
object (FlowVariables)
object
object
object
pattern property
boolean or number or object or string
workspace-id
string <uuid>

Workspace to associate with the flow, only required for Flows to support Queue

meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-flows/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-flows"
required
object
definition
object
name
string <= 255 characters
publish
boolean
object (FlowVariables)
object
object
object
pattern property
boolean or number or object or string
workspace-id
string <uuid>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows/{id}/associate-number/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
phone-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "phone-id": "d8f11fc7-5096-4a67-9227-655487c48cec"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows/{id}/disassociate-number/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
phone-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "phone-id": "d8f11fc7-5096-4a67-9227-655487c48cec"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-flows/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-flows/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-insights-call-summaries

/v1/voice-insights-call-summaries/

query Parameters
conference-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-insights-call-summaries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-insights-conference-participant-summaries

/v1/voice-insights-conference-participant-summaries/

query Parameters
conference-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-insights-conference-participant-summaries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-insights-conference-summaries

/v1/voice-insights-conference-summaries/

query Parameters
conference-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-insights-conference-summaries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-insights-conference-syncs

/v1/voice-insights-conference-syncs/

query Parameters
conference-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-insights-conference-syncs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-mail-greetings

/v1/voice-mail-greetings/

query Parameters
setting-id
required
string <uuid>
user-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-mail-greetings/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-mail-greetings"
required
object
required
object
object
object
setting-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-mail-greetings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-mail-greetings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-mail-greetings/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-mail-greetings"
required
object
object
object
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-mails

/v1/voice-mails/

query Parameters
setting-id
required
string <uuid>
filter[from-number]
string <phonenumberE164_us>
filter[owner-id]
string <uuid> (Owner User ID Filter)

Required to be the caller ID unless caller is an org admin

page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-mails/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-mails/{id}/claim-token/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
vmt
required
string <= 64 characters

Responses

Request samples

Content type
application/json
{
  • "vmt": "string"
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-outgoing-numbers

/v1/voice-outgoing-numbers/

query Parameters
setting-id
required
string <uuid>
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-outgoing-numbers/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-outgoing-numbers"
required
object
name
required
string <= 255 characters
phone-number
required
string <= 32 characters
setting-id
required
string <uuid>
display-name
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-outgoing-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-outgoing-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-outgoing-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-outgoing-numbers"
required
object
display-name
string <= 255 characters
name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-phone-book-entries

/v1/voice-phone-book-entries/

query Parameters
setting-id
required
string <uuid>
filter[extension]
string [ 1 .. 5 ] characters ^[0-9]+$
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-phone-book-entries/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-phone-book-entries"
required
object
setting-id
required
string <uuid>
auto-extension
boolean
Default: false
description
string <= 255 characters
extension
string [ 1 .. 5 ] characters ^[0-9]+$
extra-digits
string <= 64 characters
phone-number
string <phonenumberE164_us>
preference
string
Enum: "device" "phone"
user-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-phone-book-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-phone-book-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-phone-book-entries/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-phone-book-entries"
required
object
description
string <= 255 characters
extension
string [ 1 .. 5 ] characters ^[0-9]+$
extra-digits
string <= 64 characters
preference
string
Enum: "device" "phone"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-recordings

/v1/voice-recordings/

query Parameters
setting-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-recordings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-recordings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-recordings/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-recordings/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/voice-settings

/v1/voice-settings/

query Parameters
organization-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-settings/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-settings"
required
object
account-id
required
string <uuid>
phone-number
required
string <phonenumberE164>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-settings"
required
object
phone-number
string <phonenumberE164>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-survey-instances

Returns survey-instances

Returns survey-instances

query Parameters
version-id
required
string <uuid>
filter[call-id]
string <uuid>
filter[conference-id]
string <uuid>
filter[participant-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new survey instance

Creates a new survey instance

Request Body schema: application/json
required
object
type
required
string
Value: "voice-survey-instances"
required
object
participant-id
required
string <uuid>
survey-id
string <uuid>
version-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Returns specific survey instance

Returns specific survey instance

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-survey-instances/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-survey-logs

/v1/voice-survey-logs/

query Parameters
instance-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-survey-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-survey-versions

Returns surveys

Returns surveys

query Parameters
survey-id
required
string <uuid>
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new survey version

Creates a new survey version

Request Body schema: application/json
required
object
type
required
string
Value: "voice-survey-versions"
required
object
name
required
string <= 255 characters
spec
required
object
survey-id
required
string <uuid>
default
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Returns specific survey

Returns specific survey

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-surveys

Returns surveys

Returns surveys

query Parameters
setting-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new survey

Creates a new survey

Request Body schema: application/json
required
object
type
required
string
Value: "voice-surveys"
required
object
name
required
string <= 255 characters
setting-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-surveys/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific survey

Returns specific survey

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-tasks

/v1/voice-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-transcription-logs

/v1/voice-transcription-logs/

query Parameters
transcription-id
required
string <uuid>
filter[sequence][gt]
integer
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-transcription-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-transcriptions

/v1/voice-transcriptions/

query Parameters
setting-id
required
string <uuid>
filter[conference-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-transcriptions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-transcriptions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-transcriptions/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-twiml

/v1/voice-twiml/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-user-outgoing-numbers

/v1/voice-user-outgoing-numbers/

query Parameters
setting-id
required
string <uuid>
filter[outgoing-number-id]
string <uuid>
filter[user-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-user-outgoing-numbers/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-user-outgoing-numbers"
required
object
outgoing-number-id
required
string <uuid>
setting-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-user-outgoing-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-workspace-activities

/v1/voice-workspace-activities/

query Parameters
workspace-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-activities/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-activities"
required
object
name
required
string [ 1 .. 255 ] characters
workspace-id
required
string <uuid>
availability
boolean
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-activities/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-workspace-activities/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-activities/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-activities"
required
object
name
string [ 1 .. 255 ] characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-events

/v1/voice-workspace-events/

query Parameters
workspace-id
required
string <uuid>
filter[queue-id]
string <uuid>
filter[worker-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-events/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-queues

/v1/voice-workspace-queues/

query Parameters
workspace-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-queues/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-queues"
required
object
assignment-activity-id
required
string <uuid>
name
required
string [ 1 .. 255 ] characters
reservation-activity-id
required
string <uuid>
workspace-id
required
string <uuid>
target-worker-expression
string <= 2048 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-queues/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-workspace-queues/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-queues/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-queues"
required
object
assignment-activity-id
string <uuid>
max-reserved-workers
integer >= 0
name
string [ 1 .. 255 ] characters
reservation-activity-id
string <uuid>
target-worker-expression
string <= 2048 characters
task-order
string
Enum: "FIFO" "LIFO"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-queues/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
minimum-since-last-stats-update
integer >= 10
Default: 10

Minimum seconds since last stats update to trigger a new update

Responses

Request samples

Content type
application/json
{
  • "minimum-since-last-stats-update": 10
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": {
    }
}

/v1/voice-workspace-reservations

/v1/voice-workspace-reservations/

query Parameters
workspace-id
required
string <uuid>
filter[task-id]
string <uuid>
filter[worker-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-reservations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-tasks

/v1/voice-workspace-tasks/

query Parameters
workspace-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-tasks/{id}/close/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reason
required
string <= 255 characters
status
required
string
Enum: "canceled" "completed"

Responses

Request samples

Content type
application/json
{
  • "reason": "string",
  • "status": "canceled"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-tasks/{id}/sync/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-worker-queues

/v1/voice-workspace-worker-queues/

query Parameters
workspace-id
required
string <uuid>
filter[queue-id]
string <uuid>
filter[worker-id]
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-worker-queues/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-worker-queues"
required
object
queue-id
required
string <uuid>
worker-id
required
string <uuid>
workspace-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-worker-queues/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-workspace-workers

/v1/voice-workspace-workers/

query Parameters
workspace-id
required
string <uuid>
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-workers/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-workers"
required
object
user-id
required
string <uuid>
workspace-id
required
string <uuid>
attributes
object
auto-complete
boolean
Default: true
order
integer
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-workers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-workspace-workers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-workers/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-workers"
required
object
activity-id
string <uuid>
attributes
object
auto-complete
boolean
order
integer
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-workflows

/v1/voice-workspace-workflows/

query Parameters
workspace-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspace-workflows/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-workflows/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspace-workflows"
required
object
configuration
object
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspace-workflows/{id}/assign/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-workspace-workflows/{id}/status/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-workspaces

/v1/voice-workspaces/

query Parameters
setting-id
required
string <uuid>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-workspaces/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspaces"
required
object
name
required
string <= 255 characters
setting-id
required
string <uuid>
multi-task-enabled
boolean
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspaces/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-workspaces/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspaces/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-workspaces"
required
object
multi-task-enabled
boolean
Value: true

Twilio does not support disabling multi-tasking once enabled; only true is accepted.

name
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-workspaces/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v2/messaging-channels

Returns channels

Returns channels

query Parameters
organization-id
required
string <uuid>
subscriber-individual-id
required
string <uuid>

ID of individual for current user

filter[follow]
boolean
filter[individual-id]
string <uuid>

ID of individual for the channel

filter[unread]
boolean
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
object
individual-id
required
string <uuid>
name
required
string <= 128 characters
organization-id
required
string <uuid>
object
enabled
boolean
follow
boolean
Default: false
label
string <= 255 characters
text-number-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Returns specific channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
subscriber-id
string <uuid>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing channel

Modifies an existing channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
object
object
enabled
boolean
follow
boolean
label
string <= 255 characters
unread
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/messaging-channels/{id}/follow/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
active
required
boolean
subscriber-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "subscriber-id": "947992e9-9fda-4624-a818-494f2bff0810"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v2/video-channels

/v2/video-channels/{id}/finalize-encounter/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
service-type-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "service-type-id": "63dc46e8-3df8-4212-9a73-952546fcc8ae"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}