Channels management
Retrieving channels
Retrieve list of channels
Get the channels configured for a workspace
The ID of the workspace
Limits the number of results to return
10
Pagination token that keeps of track of the current position in the list
Order in which to retrieve the results
false
Filter based on platform name
^[A-Za-z0-9-]+$
Filter based on conferencial flag
false
Filter only channels I have access to
false
Filter based on channel status
preview
Possible values: Filter based on channel IDs
GET /workspaces/{workspaceId}/channels HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"results": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"platformId": "text",
"name": "text",
"connectorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"status": "active",
"contactIdentifierKeyOverride": "text",
"contactIdentifierFormatOverride": {
"type": "none",
"pattern": "text"
},
"platformServiceUrlOverride": "text",
"platformServiceVersionOverride": "1.0",
"platformServiceProtocolOverride": "http",
"platformMessageJsonSchemaOverride": {},
"platformTemplateEngineOverride": "default",
"capabilities": {
"messaging": {
"messaging": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"outgoing": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"mms": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
},
"media": {
"textFallback": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"mmLite": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"incoming": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"mms": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"voice": {
"voice": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"recording": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"settings": [
{
"key": "text",
"value": "text",
"displayName": "text",
"description": "text",
"visibility": "public"
}
],
"connectionParams": [
{
"key": "text",
"value": "text",
"displayName": "text",
"description": "text",
"visibility": "public"
}
],
"preferences": {
"disableProfileFetching": true,
"explicitMarketingOptOut": true,
"trackAdInitiatedThreads": null,
"ignoreSuppressionChecks": true,
"isPrivate": true,
"useMmLite": true
},
"useCaseId": "text",
"useCaseType": "transactional",
"channelMessageType": "promotional",
"suites": [
"marketing"
],
"resourceOwners": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "user"
}
},
"createdAt": "2025-07-03T22:39:36.666Z",
"updatedAt": "2025-07-03T22:39:36.666Z"
}
],
"nextPageToken": "text"
}
Retrieve a specific channel
Retrieve a specific workspace channel
The ID of the workspace
The ID for a channel
GET /workspaces/{workspaceId}/channels/{channelId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"platformId": "text",
"name": "text",
"connectorId": "123e4567-e89b-12d3-a456-426614174000",
"identifier": "text",
"status": "active",
"contactIdentifierKeyOverride": "text",
"contactIdentifierFormatOverride": {
"type": "none",
"pattern": "text"
},
"platformServiceUrlOverride": "text",
"platformServiceVersionOverride": "1.0",
"platformServiceProtocolOverride": "http",
"platformMessageJsonSchemaOverride": {},
"platformTemplateEngineOverride": "default",
"capabilities": {
"messaging": {
"messaging": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"outgoing": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"mms": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
},
"media": {
"textFallback": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"mmLite": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"incoming": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"mms": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"voice": {
"voice": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z",
"recording": {
"displayName": "text",
"status": "text",
"name": "text",
"version": 1,
"paused": true,
"updatedAt": "2025-07-03T22:39:36.666Z",
"createdAt": "2025-07-03T22:39:36.666Z",
"expiresAt": "2025-07-03T22:39:36.666Z"
}
},
"ANY_ADDITIONAL_PROPERTY": "anything"
}
},
"settings": [
{
"key": "text",
"value": "text",
"displayName": "text",
"description": "text",
"visibility": "public"
}
],
"connectionParams": [
{
"key": "text",
"value": "text",
"displayName": "text",
"description": "text",
"visibility": "public"
}
],
"preferences": {
"disableProfileFetching": true,
"explicitMarketingOptOut": true,
"trackAdInitiatedThreads": null,
"ignoreSuppressionChecks": true,
"isPrivate": true,
"useMmLite": true
},
"useCaseId": "text",
"useCaseType": "transactional",
"channelMessageType": "promotional",
"suites": [
"marketing"
],
"resourceOwners": {
"ANY_ADDITIONAL_PROPERTY": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"type": "user"
}
},
"createdAt": "2025-07-03T22:39:36.666Z",
"updatedAt": "2025-07-03T22:39:36.666Z"
}
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.
The ID of the workspace
The ID for a channel
The ID for a contact
The receiver identifier value.
GET /workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId} HTTP/1.1
Host:
Authorization: Bearer jwt
Accept: */*
{
"serviceWindowExpireAt": "2025-07-03T22:39:36.666Z",
"isPermanentSession": true,
"metadata": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
Last updated
Was this helpful?