Jump to Content
Enterprise Communications API
Get Started
Reference
Home
Get Started
Reference
Enterprise Communications API
Get Started
Reference
Select Product
Portal
Log In
Reference
Select Product
Portal
Log In
Reference
Cordova
All
Pages
Start typing to search…
JUMP TO
OAS and Swagger
Downloading OAS / Swagger specifications
Enterprise Communications API
Enterprise Communications API overview
Call the Enterprise Communications API
Address your messages
Message sending across channels
Custom messages
Multi-part messages
Templates
Channel selection
Additional options
Message send response
Inbound messages and receipts
Channels
SMS
Get SMS phone numbers
get
Get SMS shortcodes
get
Get SMS keywords
get
MMS
Push
WhatsApp
Facebook
App messaging
Custom channels
Branch
Webhooks
Webhooks
Message events
Profile events
Facebook events
App messaging: Conversation events
App messaging: Message events
App messaging: Session events
Chat events
Chat: Message events
Chat: Presence events
App Messaging
App Messaging Overview
Android
Install the SDK
Initialise
Start session
Client APIs
Listen to events
Push messages
Messaging service
Profile service
iOS
Install the SDK
Initialise
Start session
Push messages
Listen to events
Client APIs
Profile services
Messaging services
JavaScript
Install the SDK
Initialise
Create conversation
Send message
Query conversations
Query conversation messages
Query events
Websocket events
Message status updates
Profile API
Typescript
Cordova
Chat
Chat API
Web chat widget
Android Chat
Install the SDK
Initialise
Chat store
Start session
Client APIs
Listen to events
Messaging service
Profile service
JavaScript chat
Install the chat SDK
Initialise the Chat SDK
Chat conversation store
Chat client APIs
Chat client events
Chat client messaging service
iOS Chat
Install the SDK
Initialise
Chat store
Start session
Profile services
Messaging services
Listen to events
Client APIs
SMS
SMS API overview
SMS Reference
SMS encoding
SMS message segmentation
SMS message statuses
Verify
Verify API
Create and send a code
Validate code
Error codes
Phone Number Validation
Single number
Validate a single number
get
Bulk validation
List bulk validation jobs.
get
Bulk validate numbers
post
Get bulk job details
get
Get bulk job results
get
Enterprise Communications Message API
/apispaces/{apiSpaceId}/messages/{messageId}/statuses/{status}
Posts a status for a message
post
/apispaces/{apiSpaceId}/messages/{messageId}
Retrieves the current state of a specific message.
get
Deletes a Message
del
Patches a Message
patch
/apispaces/{apiSpaceId}/messages
Send a new message
post
/apispaces/{apiSpaceId}/messages/batch
Send a batch of new messages
post
/apispaces/{apiSpaceId}/messages/inbounds
Posts an inbound message
post
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}/statuses/{status}
Posts a status for an inbound
post
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 analytics
get
Retrieves session analytics
get
Chat
Retrieves chat analytics
get
Retrieves live chat analytics
get
Messaging
Retrieves message analytics
get
Retrieves message metrics
get
SMS
Retrieves url tracking analytics
get
Retrieves sms verify analytics
get
Retrieves inbound SMS analytics
get
Retrieves outbound SMS analytics
get
WhatsApp
Retrieves WhatsApp conversation analytics
get
Retrieves WhatsApp business-initiated conversation analytics for the last 24 hours (Daily message usage)
get
Content API
/apispaces/{apiSpaceId}/content/{fileId}
Retrieve a file
get
Message rules
/apispaces/{apiSpaceId}/automation/inboundrules/optout
Retrieves a message opt out configuration list
get
Create a message opt out configuration
post
/apispaces/{apiSpaceId}/automation/inboundrules/optout/{messageRulesId}
Retrieves single message opt out configuration
get
Update single message opt out configuration
put
Delete single message rule configuration
del
/apispaces/{apiSpaceId}/automation/inboundrules
Retrieves a message rules configuration list
get
Create a message rule configuration
post
/apispaces/{apiSpaceId}/automation/inboundrules/{messageRulesId}
Retrieves single message rule configuration
get
Update single message rule configuration
put
Delete single message rule configuration
del
Profile API
/apispaces/{apiSpaceId}/profiles/export
Exports the result of a profile query in a formatted file for download
post
/apispaces/{apiSpaceId}/profiles/bulk
Deletes the requested profiles
del
Creates or updates the supplied profiles with the supplied data
patch
/apispaces/{apiSpaceId}/profiles/{id}
Retrieves a Profile
get
Updates or undeletes a Profile
put
Deletes a Profile
del
Patches a Profile
patch
/apispaces/{apiSpaceId}/profiles/{id}/optin
Set profile opt in for specified channels
put
Set profile opt in for specified channels
del
/apispaces/{apiSpaceId}/profiles/{id}/rels/primary/{linkedId}
Creates a relationship where the linked profile is the primary and this profile is a child
put
Deletes the profile's relationship to a primary profile
del
/apispaces/{apiSpaceId}/profiles/{id}/rels/link/{linkedId}
Creates a relationship where this profile is the primary and the linked profile is a child
put
Deletes the primary profile's relationship to a linked Profile
del
/apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
Removes device from profile and closes related opened sessions
del
/apispaces/{apiSpaceId}/profiles/devices/push/validation
Retrieves push capabilities summary
post
/apispaces/{apiSpaceId}/profiles
Query profiles
get
Creates a new Profile
post
/apispaces/{apiSpaceId}/profiles/import
Start the import process
post
/apispaces/{apiSpaceId}/profiles/optin
Gets default profiles opt in/out options for each channel in channel service
get
Set default profiles opt in/out options for each channel in channel service
put
/apispaces/{apiSpaceId}/profiles/import/{id}/duplicates
Get information about duplicated profiles
get
/apispaces/{apiSpaceId}/profiles/import/{id}/start
Start the import process
put
/apispaces/{apiSpaceId}/audiences/{id}
Retrieves an audience
get
Updates an audience
put
Deletes an audience
del
/apispaces/{apiSpaceId}/audiences
Query audience
get
Creates a new audience
post
Conversation API
/apispaces/{apiSpaceId}/conversations/{conversationId}
Retrieves a conversation
get
Updates a conversation
put
Deletes a conversation
del
/apispaces/{apiSpaceId}/conversations
Retrieves a list of conversations
get
Creates a new conversation
post
/apispaces/{apiSpaceId}/conversations/{conversationId}/typing
Indicates that the caller is typing in this conversation
post
Indicates that the caller has stopped typing in this conversation
del
/apispaces/{apiSpaceId}/conversations/{conversationId}/participants
Retrieves the conversation participants
get
Adds a list of participants to a conversation
post
Deletes a list of participants from a conversation
del
Conversation Message API
/apispaces/{apiSpaceId}/conversations/{conversationId}/events
Retrieves a conversation's events
get
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages
Retrieves a conversation's messages from an point (event) in time and works backwards
get
Sends a message to conversation
post
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages/statusupdates
Posts message updates back
post
API Space Management API
/apispaces/{id}
Retrieves an API Space
get
Updates an API Space
put
Deletes an API space
del
/apispaces
Retrieves all API Spaces accessible by the current user
get
Creates a new API Space
post
/apispaces/{id}/auth
Retrieves an API Space's authentication configuration
get
Updates an API Space's authentication configuration
put
/apispaces/{id}/push
Retrieves an API Space's push configuration
get
/apispaces/{id}/retention
Retrieves an API Space's data retention configuration
get
Updates an API Space's data retention configuration
put
/apispaces/{id}/push/apns
Updates an API Space's APNS push certificate configuration
put
/apispaces/{id}/push/apns/{bundleId}/{environment}
Deletes a specific bundle from an API Space's APNS push configuration
del
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
Retrieves a bundle's APNS certificate
get
/apispaces/{id}/push/apnstoken
Updates an API Space's APNS push token configuration
put
Deletes the APNS push token configuration from an API Space's APNS push configuration
del
/apispaces/{id}/push/apnstoken/key
Retrieves the APNS key file for the API Space
get
/apispaces/{id}/push/fcm/v1/{package}
Updates an API Space's FCM push configuration
put
Session API
/apispaces/{apiSpaceId}/sessions/tokens/anon
Gets a token that can be used to start an anonymous session
get
/apispaces/{apiSpaceId}/sessions/{id}
Retrieves details about a session
get
Ends a session, revoking access to services.
del
Billing API
/accounts/{accountId}/tariff
Retrieves an account's tariff
get
Webhook API
/apispaces/{apiSpaceId}/webhooks
Retrieves a webhook configuration
get
Create a webhook configuration
post
/apispaces/{apiSpaceId}/webhooks/availableevents
Retrieves a webhook available events
get
/apispaces/{apiSpaceId}/accesstokens/availabletemplates
Gets a list of available events templates that the caller can use when creating webhook
get
/apispaces/{apiSpaceId}/webhooks/{webhookId}
Retrieves a webhook configuration
get
Updates a webhook configuration
put
Deletes a webhook configuration
del
WhatsApp Channel API
WhatsApp configurations
Get WhatsApp configuration for API Space
get
Creates WhatsApp configuration
post
WhatsApp numbers
Get WhatsApp number
get
Removes WhatsApp number
del
Registers WhatsApp number
post
WhatsApp templates
Get WhatsApp templates
get
Get WhatsApp template
get
Chat API
/apispaces/{apiSpaceId}/chats/{chatId}
Retrieves a chat
get
Updates a chat
put
Deletes a chat
del
/apispaces/{apiSpaceId}/chats/{chatId}/assign
Assigns a chat
put
/apispaces/{apiSpaceId}/chats/{chatId}/close
Closes a chat
put
/apispaces/{apiSpaceId}/chats/{chatId}/channel
Changes the channel for an existing chat
put
/apispaces/{apiSpaceId}/chats/{chatId}/form
Sends a form to a chat
post
/apispaces/{apiSpaceId}/chats
Retrieves a list of chats
get
Creates a new chat
post
/apispaces/{apiSpaceId}/chats/{chatId}/typing
Indicates that the caller is typing in this chat
post
Indicates that the caller has stopped typing in this chat
del
/apispaces/{apiSpaceId}/chats/{chatId}/participants
Retrieves the chat participants
get
Chat Message API
/apispaces/{apiSpaceId}/chats/{chatId}/events
Retrieves a chat's events
get
/apispaces/{apiSpaceId}/chats/{chatId}/messages
Retrieves a chat's messages from an point (event) in time and works backwards
get
Sends a message to chat
post
/apispaces/{apiSpaceId}/chats/{chatId}/messages/statusupdates
Posts message updates back
post
Chat Config API
/apispaces/{apiSpaceId}/chat/config
Retrieves the chat configuration for an apiSpace
get
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}
Retrieves the members of a team
get
Removes the config for a team
del
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/sms
Update the SMS config for a team
put
Removes the SMS config for a team
del
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/fbMessenger
Update the Facebook Messenger config for a team
put
Removes the Facebook Messenger config for a team
del
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/appMessaging
Update the App Messaging config for a team
put
Removes the App Messaging config for a team
del
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/email
Update the email config for a team
put
Removes the email config for a team
del
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/settings
Update general settings for a team
put
Removes the settings for a team
del
Partner : Reseller API
Partner/Reseller API Overview
Accounts
Add Account
post
Get Accounts
post
Get Account Details
post
Update Account Details
post
Delete Account
post
Get Market Sectors
post
Users
Get Users
post
Get User Details
post
Update User Details
post
Password Reset
post
Delete User
post
Undelete User
post
Add User to Account
post
Billing
Get Chargeable Activity
post
Get Account Credit
post
Adjust Credit
post
Add Credit
post
Get Account Credit Bundles
post
Security
Get Available Roles
post
Get Default Roles
post
Set Default Roles
post
Get User Roles
post
Add Role to User
post
Remove Role from User
post
Numbers
Get Inbound Numbers
post
Allocate Inbound Number
post
Deallocate Inbound Number
post
Authentication
Authenticate
post
Reference
MIME Types
Cordova
Ask AI
The JavaScript App Messaging Foundation SDK can be incorporated into a Cordova app.
