For AI agents: the docs index is at https://cpaas.developer.dotdigital.com/llms.txt. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Get Started Reference Changelog

Home Get Started Reference

Get Started Reference Changelog Select Product Portal Log In

Reference

Select Product Portal Log In

OAS and Swagger

Downloading OAS / Swagger specifications

Enterprise Communications API

Enterprise Communications API overview
Channels
Branch

Webhooks

Webhooks

App Messaging

App Messaging Overview
Android
iOS
JavaScript
Cordova

Chat

Chat API
Web chat widget
Android Chat
JavaScript chat
iOS Chat

SMS

SMS API overview
SMS Reference

Verify

Verify API
Create and send a code
Validate code
Error codes

Phone Number Validation

Single number
- Validate a single numberget
Bulk validation

Enterprise Communications Message API

/apispaces/{apiSpaceId}/messages/{messageId}/statuses/{status}
- Posts a status for a messagepost
/apispaces/{apiSpaceId}/messages/{messageId}
/apispaces/{apiSpaceId}/messages
- Send a new messagepost
/apispaces/{apiSpaceId}/messages/batch
- Send a batch of new messagespost
/apispaces/{apiSpaceId}/messages/inbounds
- Posts an inbound messagepost
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}/statuses/{status}
- Posts a status for an inboundpost

Message History API

/apispaces/{apiSpaceId}/profiles/{profileId}/messages
- Retrieves message history for the specified profile. Messages retrieved from the date spacified (default now), in descending time order.get

Analytics API

App Messaging
- Retrieves conversation message analyticsget
- Retrieves session analyticsget
Chat
- Retrieves chat analyticsget
- Retrieves live chat analyticsget
Messaging
- Retrieves message analyticsget
- Retrieves message metricsget
SMS
WhatsApp
- Retrieves WhatsApp conversation analyticsget
- Retrieves WhatsApp business-initiated conversation analytics for the last 24 hours (Daily message usage)get

Content API

/apispaces/{apiSpaceId}/content/{fileId}
- Retrieve a fileget

Message rules

/apispaces/{apiSpaceId}/automation/inboundrules/optout
- Retrieves a message opt out configuration listget
- Create a message opt out configurationpost
/apispaces/{apiSpaceId}/automation/inboundrules/optout/{messageRulesId}
/apispaces/{apiSpaceId}/automation/inboundrules
- Retrieves a message rules configuration listget
- Create a message rule configurationpost
/apispaces/{apiSpaceId}/automation/inboundrules/{messageRulesId}

Profile API

/apispaces/{apiSpaceId}/profiles/export
- Exports the result of a profile query in a formatted file for downloadpost
/apispaces/{apiSpaceId}/profiles/bulk
- Deletes the requested profilesdel
- Creates or updates the supplied profiles with the supplied datapatch
/apispaces/{apiSpaceId}/profiles/{id}
/apispaces/{apiSpaceId}/profiles/{id}/optin
- Set profile opt in for specified channelsput
- Set profile opt in for specified channelsdel
/apispaces/{apiSpaceId}/profiles/{id}/rels/primary/{linkedId}
- Creates a relationship where the linked profile is the primary and this profile is a childput
- Deletes the profile's relationship to a primary profiledel
/apispaces/{apiSpaceId}/profiles/{id}/rels/link/{linkedId}
- Creates a relationship where this profile is the primary and the linked profile is a childput
- Deletes the primary profile's relationship to a linked Profiledel
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
- Removes device from profile and closes related opened sessionsdel
/apispaces/{apiSpaceId}/profiles/devices/push/validation
- Retrieves push capabilities summarypost
/apispaces/{apiSpaceId}/profiles
- Query profilesget
- Creates a new Profilepost
/apispaces/{apiSpaceId}/profiles/import
- Start the import processpost
/apispaces/{apiSpaceId}/profiles/optin
- Gets default profiles opt in/out options for each channel in channel serviceget
- Set default profiles opt in/out options for each channel in channel serviceput
/apispaces/{apiSpaceId}/profiles/import/{id}/duplicates
- Get information about duplicated profilesget
/apispaces/{apiSpaceId}/profiles/import/{id}/start
- Start the import processput
/apispaces/{apiSpaceId}/audiences/{id}
/apispaces/{apiSpaceId}/audiences
- Query audienceget
- Creates a new audiencepost

Conversation API

/apispaces/{apiSpaceId}/conversations/{conversationId}
/apispaces/{apiSpaceId}/conversations
- Retrieves a list of conversationsget
- Creates a new conversationpost
/apispaces/{apiSpaceId}/conversations/{conversationId}/typing
- Indicates that the caller is typing in this conversationpost
- Indicates that the caller has stopped typing in this conversationdel
/apispaces/{apiSpaceId}/conversations/{conversationId}/participants

Conversation Message API

/apispaces/{apiSpaceId}/conversations/{conversationId}/events
- Retrieves a conversation's eventsget
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages
- Retrieves a conversation's messages from an point (event) in time and works backwardsget
- Sends a message to conversationpost
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages/statusupdates
- Posts message updates backpost

API Space Management API

/apispaces/{id}
/apispaces
- Retrieves all API Spaces accessible by the current userget
- Creates a new API Spacepost
/apispaces/{id}/auth
- Retrieves an API Space's authentication configurationget
- Updates an API Space's authentication configurationput
/apispaces/{id}/push
- Retrieves an API Space's push configurationget
/apispaces/{id}/retention
- Retrieves an API Space's data retention configurationget
- Updates an API Space's data retention configurationput
/apispaces/{id}/push/apns
- Updates an API Space's APNS push certificate configurationput
/apispaces/{id}/push/apns/{bundleId}/{environment}
- Deletes a specific bundle from an API Space's APNS push configurationdel
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
- Retrieves a bundle's APNS certificateget
/apispaces/{id}/push/apnstoken
- Updates an API Space's APNS push token configurationput
- Deletes the APNS push token configuration from an API Space's APNS push configurationdel
/apispaces/{id}/push/apnstoken/key
- Retrieves the APNS key file for the API Spaceget
/apispaces/{id}/push/fcm/v1/{package}
- Updates an API Space's FCM push configurationput

Session API

/apispaces/{apiSpaceId}/sessions/tokens/anon
- Gets a token that can be used to start an anonymous sessionget
/apispaces/{apiSpaceId}/sessions/{id}
- Retrieves details about a sessionget
- Ends a session, revoking access to services.del

Billing API

/accounts/{accountId}/tariff
- Retrieves an account's tariffget

Webhook API

/apispaces/{apiSpaceId}/webhooks
- Retrieves a webhook configurationget
- Create a webhook configurationpost
/apispaces/{apiSpaceId}/webhooks/availableevents
- Retrieves a webhook available eventsget
/apispaces/{apiSpaceId}/accesstokens/availabletemplates
- Gets a list of available events templates that the caller can use when creating webhookget
/apispaces/{apiSpaceId}/webhooks/{webhookId}

WhatsApp Channel API

WhatsApp configurations
- Get WhatsApp configuration for API Spaceget
- Creates WhatsApp configurationpost
WhatsApp numbers
WhatsApp templates
- Get WhatsApp templatesget
- Get WhatsApp templateget

Chat API

/apispaces/{apiSpaceId}/chats/{chatId}
/apispaces/{apiSpaceId}/chats/{chatId}/assign
- Assigns a chatput
/apispaces/{apiSpaceId}/chats/{chatId}/close
- Closes a chatput
/apispaces/{apiSpaceId}/chats/{chatId}/channel
- Changes the channel for an existing chatput
/apispaces/{apiSpaceId}/chats/{chatId}/form
- Sends a form to a chatpost
/apispaces/{apiSpaceId}/chats
- Retrieves a list of chatsget
- Creates a new chatpost
/apispaces/{apiSpaceId}/chats/{chatId}/typing
- Indicates that the caller is typing in this chatpost
- Indicates that the caller has stopped typing in this chatdel
/apispaces/{apiSpaceId}/chats/{chatId}/participants
- Retrieves the chat participantsget

Chat Message API

/apispaces/{apiSpaceId}/chats/{chatId}/events
- Retrieves a chat's eventsget
/apispaces/{apiSpaceId}/chats/{chatId}/messages
- Retrieves a chat's messages from an point (event) in time and works backwardsget
- Sends a message to chatpost
/apispaces/{apiSpaceId}/chats/{chatId}/messages/statusupdates
- Posts message updates backpost

Chat Config API

/apispaces/{apiSpaceId}/chat/config
- Retrieves the chat configuration for an apiSpaceget
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}
- Retrieves the members of a teamget
- Removes the config for a teamdel
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/sms
- Update the SMS config for a teamput
- Removes the SMS config for a teamdel
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/fbMessenger
- Update the Facebook Messenger config for a teamput
- Removes the Facebook Messenger config for a teamdel
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/appMessaging
- Update the App Messaging config for a teamput
- Removes the App Messaging config for a teamdel
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/email
- Update the email config for a teamput
- Removes the email config for a teamdel
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/settings
- Update general settings for a teamput
- Removes the settings for a teamdel

Partner : Reseller API

Partner/Reseller API Overview
Accounts
Users
Billing
Security
Numbers

Authentication

Authenticatepost

Reference

MIME Types

SMS Reference

The following pages contain useful reference information when working with our SMS APIs.

Updated 12 months ago

SMS API overview

Updated 12 months ago

SMS API overview