Channels management
Retrieving channels
Retrieve list of channels
Get the channels configured for a workspace
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
Query parameters
limitinteger · min: 1 · max: 1000OptionalDefault:
Limits the number of results to return
10
pageTokenstring · max: 8000Optional
Pagination token that keeps of track of the current position in the list
reversebooleanOptionalDefault:
Order in which to retrieve the results
false
platformany ofOptional
Filter based on platform name
string · min: 3 · max: 60OptionalPattern:
^[A-Za-z0-9-]+$
string[]Optional
conferencialbooleanOptionalDefault:
Filter based on conferencial flag
false
onlyMyChannelsbooleanOptionalDefault:
Filter only channels I have access to
false
statusany ofOptional
Filter based on channel status
string · enumOptionalDefault:
preview
Possible values: stringOptional
useCaseTypestring · enumOptionalPossible values:
channelIdsstring · uuid[]Optional
Filter based on channel IDs
Responses
200
OK
application/json
Responseall of
404
The request did not pass validation
application/json
get
Retrieve a specific channel
Check if customer service window is open
For some channels it is only possible to send non template messages if the customer service window is open. The following endpoint will return the expiry time for any active service windows
Retrieve channel information for a given contact.
Authorizations
Path parameters
workspaceIdstring · uuidRequired
The ID of the workspace
channelIdstring · uuidRequired
The ID for a channel
contactIdstring · uuidRequired
The ID for a contact
Query parameters
contactIdentifierValuestringOptional
The receiver identifier value.
Responses
200
OK
application/json
404
The request did not pass validation
application/json
get
Last updated
Was this helpful?