Channels management

Retrieving channels

Retrieve list of channels

Get workspace channels

Get the channels configured for a workspace

GET/workspaces/{workspaceId}/channels

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

Query parameters

Response

200404

OK

Body

application/json

resultsarray of Channel

nextPageTokenstring

The token that can be passed as pageToken in URL to retrieve the next set of results. If missing, no more results to display.

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "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",
      "platformTemplateEngineOverride": "default",
      "capabilities": {
        "messaging": {
          "messaging": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 0,
            "updatedAt": "2024-04-29T15:40:34.886Z",
            "createdAt": "2024-04-29T15:40:34.886Z",
            "expiresAt": "2024-04-29T15:40:34.886Z",
            "outgoing": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 0,
              "updatedAt": "2024-04-29T15:40:34.886Z",
              "createdAt": "2024-04-29T15:40:34.886Z",
              "expiresAt": "2024-04-29T15:40:34.886Z",
              "mms": {
                "displayName": "text",
                "status": "text",
                "name": "text",
                "version": 0,
                "paused": false,
                "updatedAt": "2024-04-29T15:40:34.886Z",
                "createdAt": "2024-04-29T15:40:34.886Z",
                "expiresAt": "2024-04-29T15:40:34.886Z"
              },
              "media": {
                "textFallback": {
                  "displayName": "text",
                  "status": "text",
                  "name": "text",
                  "version": 0,
                  "paused": false,
                  "updatedAt": "2024-04-29T15:40:34.886Z",
                  "createdAt": "2024-04-29T15:40:34.886Z",
                  "expiresAt": "2024-04-29T15:40:34.886Z"
                }
              }
            },
            "incoming": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 0,
              "updatedAt": "2024-04-29T15:40:34.886Z",
              "createdAt": "2024-04-29T15:40:34.886Z",
              "expiresAt": "2024-04-29T15:40:34.886Z",
              "mms": {
                "displayName": "text",
                "status": "text",
                "name": "text",
                "version": 0,
                "paused": false,
                "updatedAt": "2024-04-29T15:40:34.886Z",
                "createdAt": "2024-04-29T15:40:34.886Z",
                "expiresAt": "2024-04-29T15:40:34.886Z"
              }
            }
          }
        },
        "voice": {
          "voice": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 0,
            "updatedAt": "2024-04-29T15:40:34.886Z",
            "createdAt": "2024-04-29T15:40:34.886Z",
            "expiresAt": "2024-04-29T15:40:34.886Z",
            "recording": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 0,
              "paused": false,
              "updatedAt": "2024-04-29T15:40:34.886Z",
              "createdAt": "2024-04-29T15:40:34.886Z",
              "expiresAt": "2024-04-29T15:40:34.886Z"
            }
          }
        }
      },
      "settings": [
        {
          "key": "text",
          "value": "text",
          "displayName": "text",
          "description": "text",
          "visibility": "public"
        }
      ],
      "connectionParams": [
        {
          "key": "text",
          "value": "text",
          "displayName": "text",
          "description": "text",
          "visibility": "public"
        }
      ],
      "preferences": {
        "disableProfileFetching": false,
        "explicitMarketingOptOut": false
      },
      "useCaseId": "text",
      "useCaseType": "transactional",
      "suites": [
        "marketing"
      ],
      "createdAt": "2024-04-29T15:40:34.886Z",
      "updatedAt": "2024-04-29T15:40:34.886Z"
    }
  ],
  "nextPageToken": "text"
}

Retrieve a specific channel

Get channel

Retrieve a specific workspace channel

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

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

Response

200404

OK

Body

application/json

id*Id-2 (string (uuid))

platformId*Id (string)

name*Name (string)

connectorId*ConnectorId (string (uuid))

identifierIdentifier (string)

status*Status-2 (enum)

activependingsetting-upfailedinactivedeleted

contactIdentifierKeyOverridenullable ContactIdentifierKeyOverride (string)

contactIdentifierFormatOverridenullable ContactIdentifierFormatOverride (object)

platformServiceUrlOverridenullable PlatformServiceUrlOverride (string)

platformServiceVersionOverridenullable PlatformServiceVersionOverride (enum)

1.0

platformServiceProtocolOverridenullable PlatformServiceProtocolOverride (enum)

httphttps

platformMessageJsonSchemaOverridenullable PlatformMessageJsonSchemaOverride (object)

platformTemplateEngineOverridenullable PlatformTemplateEngineOverride (enum)

defaultliquid

capabilitiesChannelCapabilities (object)

settingsSettings (array of object)

connectionParamsSettings (array of object)

preferencesnullable Preferences (object)

useCaseIdnullable UseCaseId (string)

useCaseTypenullable UseCaseType-2 (enum)

transactionalmarketingconversation

suitesarray of SuiteType (enum)

createdAt*string (date-time)

updatedAtstring (date-time)

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "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",
  "platformTemplateEngineOverride": "default",
  "capabilities": {
    "messaging": {
      "messaging": {
        "displayName": "text",
        "status": "text",
        "name": "text",
        "version": 0,
        "updatedAt": "2024-04-29T15:40:34.886Z",
        "createdAt": "2024-04-29T15:40:34.886Z",
        "expiresAt": "2024-04-29T15:40:34.886Z",
        "outgoing": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 0,
          "updatedAt": "2024-04-29T15:40:34.886Z",
          "createdAt": "2024-04-29T15:40:34.886Z",
          "expiresAt": "2024-04-29T15:40:34.886Z",
          "mms": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 0,
            "paused": false,
            "updatedAt": "2024-04-29T15:40:34.886Z",
            "createdAt": "2024-04-29T15:40:34.886Z",
            "expiresAt": "2024-04-29T15:40:34.886Z"
          },
          "media": {
            "textFallback": {
              "displayName": "text",
              "status": "text",
              "name": "text",
              "version": 0,
              "paused": false,
              "updatedAt": "2024-04-29T15:40:34.886Z",
              "createdAt": "2024-04-29T15:40:34.886Z",
              "expiresAt": "2024-04-29T15:40:34.886Z"
            }
          }
        },
        "incoming": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 0,
          "updatedAt": "2024-04-29T15:40:34.886Z",
          "createdAt": "2024-04-29T15:40:34.886Z",
          "expiresAt": "2024-04-29T15:40:34.886Z",
          "mms": {
            "displayName": "text",
            "status": "text",
            "name": "text",
            "version": 0,
            "paused": false,
            "updatedAt": "2024-04-29T15:40:34.886Z",
            "createdAt": "2024-04-29T15:40:34.886Z",
            "expiresAt": "2024-04-29T15:40:34.886Z"
          }
        }
      }
    },
    "voice": {
      "voice": {
        "displayName": "text",
        "status": "text",
        "name": "text",
        "version": 0,
        "updatedAt": "2024-04-29T15:40:34.886Z",
        "createdAt": "2024-04-29T15:40:34.886Z",
        "expiresAt": "2024-04-29T15:40:34.886Z",
        "recording": {
          "displayName": "text",
          "status": "text",
          "name": "text",
          "version": 0,
          "paused": false,
          "updatedAt": "2024-04-29T15:40:34.886Z",
          "createdAt": "2024-04-29T15:40:34.886Z",
          "expiresAt": "2024-04-29T15:40:34.886Z"
        }
      }
    }
  },
  "settings": [
    {
      "key": "text",
      "value": "text",
      "displayName": "text",
      "description": "text",
      "visibility": "public"
    }
  ],
  "connectionParams": [
    {
      "key": "text",
      "value": "text",
      "displayName": "text",
      "description": "text",
      "visibility": "public"
    }
  ],
  "preferences": {
    "disableProfileFetching": false,
    "explicitMarketingOptOut": false
  },
  "useCaseId": "text",
  "useCaseType": "transactional",
  "suites": [
    "marketing"
  ],
  "createdAt": "2024-04-29T15:40:34.886Z",
  "updatedAt": "2024-04-29T15:40:34.886Z"
}

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}

Authorization

useraccessKey

Path parameters

workspaceId*string (uuid)

The ID of the workspace

channelId*string (uuid)

The ID for a channel

contactId*string (uuid)

The ID for a contact

Response

200404

OK

Body

application/json

serviceWindowExpireAt*nullable string (date-time)

isPermanentSessionnullable boolean

metadatanullable object

Request

JavaScriptCurl

const response = await fetch('/workspaces/{workspaceId}/channels/{channelId}/contacts/{contactId}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer jwt"
    },
});
const data = await response.json();

Response

{
  "serviceWindowExpireAt": "2024-04-29T15:40:34.886Z",
  "isPermanentSession": false
}