Channels management

Retrieving channels

Retrieve list of channels

Get workspace channels

Get the channels configured for a workspace

get

/workspaces/{workspaceId}/channels

Authorizations

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

Query parameters

limitinteger · min: 1 · max: 1000 · default: 10

Limits the number of results to return

pageTokenstring · max: 8000

Pagination token that keeps of track of the current position in the list

reverseboolean

Order in which to retrieve the results

platformany of

Filter based on platform name

conferencialboolean

Filter based on conferencial flag

onlyMyChannelsboolean

Filter only channels I have access to

statusany of

Filter based on channel status

useCaseTypestring · enum

Options: otp, transactional, marketing, conversation

channelIdsstring · uuid[]

Filter based on channel IDs

suitestring · enum[]

Filter entities by Suite

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/channels' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "platformId": "text",
      "name": "text",
      "connectorId": "123e4567-e89b-12d3-a456-426614174000",
      "identifier": "text",
      "status": "active",
      "contactIdentifierKeyOverride": "text",
      "contactIdentifierFormatOverride": {
        "pattern": "text",
        "type": "none"
      },
      "platformServiceUrlOverride": "text",
      "platformServiceVersionOverride": "1.0",
      "platformServiceProtocolOverride": "http",
      "platformMessageJsonSchemaOverride": {},
      "platformTemplateEngineOverride": "default",
      "capabilities": {
        "messaging": {
          "messaging": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 1,
            "updatedAt": "2025-02-21T18:21:49.421Z",
            "createdAt": "2025-02-21T18:21:49.421Z",
            "expiresAt": "2025-02-21T18:21:49.421Z",
            "outgoing": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 1,
              "updatedAt": "2025-02-21T18:21:49.421Z",
              "createdAt": "2025-02-21T18:21:49.421Z",
              "expiresAt": "2025-02-21T18:21:49.421Z",
              "mms": {
                "displayName": "text",
                "status": "text",
                "name": "text",
                "version": 1,
                "paused": true,
                "updatedAt": "2025-02-21T18:21:49.421Z",
                "createdAt": "2025-02-21T18:21:49.421Z",
                "expiresAt": "2025-02-21T18:21:49.421Z"
              },
              "media": {
                "textFallback": {
                  "displayName": "text",
                  "status": "text",
                  "name": "text",
                  "version": 1,
                  "paused": true,
                  "updatedAt": "2025-02-21T18:21:49.421Z",
                  "createdAt": "2025-02-21T18:21:49.421Z",
                  "expiresAt": "2025-02-21T18:21:49.421Z"
                }
              }
            },
            "incoming": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 1,
              "updatedAt": "2025-02-21T18:21:49.421Z",
              "createdAt": "2025-02-21T18:21:49.421Z",
              "expiresAt": "2025-02-21T18:21:49.421Z",
              "mms": {
                "displayName": "text",
                "status": "text",
                "name": "text",
                "version": 1,
                "paused": true,
                "updatedAt": "2025-02-21T18:21:49.421Z",
                "createdAt": "2025-02-21T18:21:49.421Z",
                "expiresAt": "2025-02-21T18:21:49.421Z"
              }
            }
          },
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "voice": {
          "voice": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 1,
            "updatedAt": "2025-02-21T18:21:49.421Z",
            "createdAt": "2025-02-21T18:21:49.421Z",
            "expiresAt": "2025-02-21T18:21:49.421Z",
            "recording": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 1,
              "paused": true,
              "updatedAt": "2025-02-21T18:21:49.421Z",
              "createdAt": "2025-02-21T18:21:49.421Z",
              "expiresAt": "2025-02-21T18:21:49.421Z"
            }
          },
          "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
      },
      "useCaseId": "text",
      "useCaseType": "transactional",
      "channelMessageType": "promotional",
      "createdAt": "2025-02-21T18:21:49.421Z",
      "updatedAt": "2025-02-21T18:21:49.421Z",
      "suites": [
        "marketing"
      ]
    }
  ],
  "nextPageToken": "text"
}

Retrieve a specific channel

Get channel

Retrieve a specific workspace channel

get

/workspaces/{workspaceId}/channels/{channelId}

Authorizations

Path parameters

workspaceIdstring · uuidrequired

The ID of the workspace

channelIdstring · uuidrequired

The ID for a channel

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "platformId": "text",
  "name": "text",
  "connectorId": "123e4567-e89b-12d3-a456-426614174000",
  "identifier": "text",
  "status": "active",
  "contactIdentifierKeyOverride": "text",
  "contactIdentifierFormatOverride": {
    "pattern": "text",
    "type": "none"
  },
  "platformServiceUrlOverride": "text",
  "platformServiceVersionOverride": "1.0",
  "platformServiceProtocolOverride": "http",
  "platformMessageJsonSchemaOverride": {},
  "platformTemplateEngineOverride": "default",
  "capabilities": {
    "messaging": {
      "messaging": {
        "displayName": "text",
        "status": "text",
        "name": "text",
        "version": 1,
        "updatedAt": "2025-02-21T18:21:49.421Z",
        "createdAt": "2025-02-21T18:21:49.421Z",
        "expiresAt": "2025-02-21T18:21:49.421Z",
        "outgoing": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 1,
          "updatedAt": "2025-02-21T18:21:49.421Z",
          "createdAt": "2025-02-21T18:21:49.421Z",
          "expiresAt": "2025-02-21T18:21:49.421Z",
          "mms": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 1,
            "paused": true,
            "updatedAt": "2025-02-21T18:21:49.421Z",
            "createdAt": "2025-02-21T18:21:49.421Z",
            "expiresAt": "2025-02-21T18:21:49.421Z"
          },
          "media": {
            "textFallback": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 1,
              "paused": true,
              "updatedAt": "2025-02-21T18:21:49.421Z",
              "createdAt": "2025-02-21T18:21:49.421Z",
              "expiresAt": "2025-02-21T18:21:49.421Z"
            }
          }
        },
        "incoming": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 1,
          "updatedAt": "2025-02-21T18:21:49.421Z",
          "createdAt": "2025-02-21T18:21:49.421Z",
          "expiresAt": "2025-02-21T18:21:49.421Z",
          "mms": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 1,
            "paused": true,
            "updatedAt": "2025-02-21T18:21:49.421Z",
            "createdAt": "2025-02-21T18:21:49.421Z",
            "expiresAt": "2025-02-21T18:21:49.421Z"
          }
        }
      },
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "voice": {
      "voice": {
        "displayName": "text",
        "status": "text",
        "name": "text",
        "version": 1,
        "updatedAt": "2025-02-21T18:21:49.421Z",
        "createdAt": "2025-02-21T18:21:49.421Z",
        "expiresAt": "2025-02-21T18:21:49.421Z",
        "recording": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 1,
          "paused": true,
          "updatedAt": "2025-02-21T18:21:49.421Z",
          "createdAt": "2025-02-21T18:21:49.421Z",
          "expiresAt": "2025-02-21T18:21:49.421Z"
        }
      },
      "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
  },
  "useCaseId": "text",
  "useCaseType": "transactional",
  "channelMessageType": "promotional",
  "createdAt": "2025-02-21T18:21:49.421Z",
  "updatedAt": "2025-02-21T18:21:49.421Z",
  "suites": [
    "marketing"
  ]
}

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

Get channel details for a contact

Retrieve channel information for a given contact.

get

/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}

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

contactIdentifierValuestring

The receiver identifier value.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}' \
  --header 'Authorization: Bearer jwt'

200

404

{
  "serviceWindowExpireAt": "2025-02-21T18:21:49.421Z",
  "isPermanentSession": true,
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

Last updated 9 months ago

Was this helpful?