Engagement Cloud | CPaaS

Get Started
Reference
Knowledge Base
Portal
Looking for Engagement Cloud docs

{{user.name}}Log In

Engagement Cloud | CPaaS docs

Comapi is now part of the dotdigital Engagement Cloud providing CPaaS services.

You'll find comprehensive guides and documentation to help you start working with the Engagement Cloud | CPaaS services as quickly as possible,
as well as support if you get stuck. Let's jump right in!

HomeGet StartedRecipesReferenceReferenceChangelogCommunityPage Not FoundSearch{{ state.current().meta.title }}API Logs

Get Started

Overview
Quick Start
Channel Setup
Branch
Opt Ins
Permissions
Terminology

Quick Starts

Send SMS Messages
Using Facebook
Receiving Data using Webhooks
Facebook Instant Games and Messaging

Integrations

Integrating Bots
- Meya.ai Integration
Wordpress
Zapier

Trust Centre

Hosting Overview
Security
Data Processing Agreement
Firewalls
GDPR
- Data Preferences
RIPE Registration
Brexit FAQs
FAQs: dotdigital & Brexit

Get Started

Overview
Quick Start
Channel Setup
Branch
Opt Ins
Permissions
Terminology

Quick Starts

Send SMS Messages
Using Facebook
Receiving Data using Webhooks
Facebook Instant Games and Messaging

Integrations

Integrating Bots
- Meya.ai Integration
Wordpress
Zapier

Trust Centre

Hosting Overview
Security
Data Processing Agreement
Firewalls
GDPR
- Data Preferences
RIPE Registration
Brexit FAQs
FAQs: dotdigital & Brexit

The "One" API

The One 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
URL Click Forwarding

Verify

Verify API
Create and Send Code
Validate Code
Verify Error Codes

Phone Number Validation

Phone Number Validation
Number Status Values
REST API

Message "One" API

/apispaces/{apiSpaceId}/messages/{messageId}/statuses/{status}
- post
  Posts a status for a message
/apispaces/{apiSpaceId}/messages/{messageId}
/apispaces/{apiSpaceId}/messages
- post
  Send a new message
/apispaces/{apiSpaceId}/messages/batch
- post
  Send a batch of new messages
/apispaces/{apiSpaceId}/messages/inbounds
- post
  Posts an inbound message
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}
/apispaces/{apiSpaceId}/messages/mirror/{channel}
- post
  Creates a mirror of a batch of messages sent directly by a channel
/apispaces/{apiSpaceId}/messages/status/{channel}
- post
  Loads a batch of status changes for messages sent directly by a channel
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}/statuses/{status}
- post
  Posts a status for an inbound

Message History API

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

Content API

/apispaces/{apiSpaceId}/content/{fileId}
- get
  Retrieve a file

Profile API

/apispaces/{apiSpaceId}/profiles/export
- post
  Exports the result of a profile query in a formatted file for download
/apispaces/{apiSpaceId}/profiles/bulk
- patch
  Creates or updates the supplied profiles with the supplied data
- delete
  Deletes the requested profiles
/apispaces/{apiSpaceId}/profiles/{id}
/apispaces/{apiSpaceId}/profiles/{id}/optin
- put
  Set profile opt in for specified channels
- delete
  Set profile opt in for specified channels
/apispaces/{apiSpaceId}/profiles/{id}/rels/primary/{linkedId}
- put
  Creates a relationship where the linked profile is the primary and this profile is a child
- delete
  Deletes the profile's relationship to a primary profile
/apispaces/{apiSpaceId}/profiles/{id}/rels/link/{linkedId}
- put
  Creates a relationship where this profile is the primary and the linked profile is a child
- delete
  Deletes the primary profile's relationship to a linked Profile
/apispaces/{apiSpaceId}/profiles
- get
  Query profiles
- post
  Creates a new Profile
/apispaces/{apiSpaceId}/profiles/import
- post
  Start the import process
/apispaces/{apiSpaceId}/profiles/optin
- get
  Gets default profiles opt in/out options for each channel in channel service
- put
  Set default profiles opt in/out options for each channel in channel service
/apispaces/{apiSpaceId}/profiles/import/{id}/duplicates
- get
  Get information about duplicated profiles
/apispaces/{apiSpaceId}/profiles/import/{id}/start
- put
  Start the import process
/apispaces/{apiSpaceId}/audiences/{id}
/apispaces/{apiSpaceId}/audiences
- get
  Query audience
- post
  Creates a new audience

Conversation API

/apispaces/{apiSpaceId}/conversations/{conversationId}
/apispaces/{apiSpaceId}/conversations
- post
  Creates a new conversation
- get
  Retrieves a list of conversations
/apispaces/{apiSpaceId}/conversations/{conversationId}/typing
- post
  Indicates that the caller is typing in this conversation
- delete
  Indicates that the caller has stopped typing in this conversation
/apispaces/{apiSpaceId}/conversations/{conversationId}/participants

Conversation Message API

/apispaces/{apiSpaceId}/conversations/{conversationId}/events
- get
  Retrieves a conversation's events
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages
- post
  Sends a message to conversation
- get
  Retrieves a conversation's messages from an point (event) in time and works backwards
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages/statusupdates
- post
  Posts message updates back

Analytics API

/apispaces/{apiSpaceId}/analytics/conversationmessages
- get
  Retrieves conversation message analytics
/apispaces/{apiSpaceId}/analytics/messages
- get
  Retrieves message analytics
/apispaces/{apiSpaceId}/analytics/sessions
- get
  Retrieves session analytics
/apispaces/{apiSpaceId}/analytics/sms/tracking
- get
  Retrieves url tracking analytics
/apispaces/{apiSpaceId}/analytics/sms/verify
- get
  Retrieves sms verify analytics
/apispaces/{apiSpaceId}/analytics/sms/inbound
- get
  Retrieves inbound SMS analytics
/apispaces/{apiSpaceId}/analytics/sms/outbound
- get
  Retrieves outbound SMS analytics

Facebook API

post
Facebook Meta Data Service

Integrator API

get
Getting Message Statuses
get
Profile Schema Retrieval
post
Authenticate

API Space Management API

/apispaces/{id}
/apispaces
- get
  Retrieves all API Spaces accessible by the current user
- post
  Creates a new API Space
/apispaces/{id}/auth
- get
  Retrieves an API Space's authentication configuration
- put
  Updates an API Space's authentication configuration
/apispaces/{id}/push
- get
  Retrieves an API Space's push configuration
/apispaces/{id}/retention
- get
  Retrieves an API Space's data retention configuration
- put
  Updates an API Space's data retention configuration
/apispaces/{id}/push/apns
- put
  Updates an API Space's APNS push certificate configuration
/apispaces/{id}/push/apns/{bundleId}/{environment}
- delete
  Deletes a specific bundle from an API Space's APNS push configuration
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
- get
  Retrieves a bundle's APNS certificate
/apispaces/{id}/push/apnstoken
- put
  Updates an API Space's APNS push token configuration
- delete
  Deletes the APNS push token configuration from an API Space's APNS push configuration
/apispaces/{id}/push/apnstoken/key
- get
  Retrieves the APNS key file for the API Space
/apispaces/{id}/push/fcm/{package}
- put
  Updates an API Space's FCM push configuration
- delete
  Deletes a specific package from an API Space's FCM push configuration

Billing API

/accounts/{accountId}/tariff
- get
  Retrieves an account's tariff
/accounts/{accountId}/transactions
- get
  Retrieves an account's transaction history. Spends such as monthly profile bill, SMS message sends, PNV lookups and SMS inbound numbers appear as debits, i.e. negative amounts. Invoice or card payments appear as positive credits to the account.
/accounts/{accountId}/wallet
- get
  Retrieves a prepay account's wallet balance

Session API

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

Webhook API

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

Message Rules API

/apispaces/{apiSpaceId}/automation/inboundrules/optout
- get
  Retrieves a message opt out configuration list
- post
  Create a message opt out configuration
/apispaces/{apiSpaceId}/automation/inboundrules/optout/{messageRulesId}
/apispaces/{apiSpaceId}/automation/inboundrules
- get
  Retrieves a message rules configuration list
- post
  Create a message rule configuration
/apispaces/{apiSpaceId}/automation/inboundrules/{messageRulesId}

Chat API

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

Chat Message API

/apispaces/{apiSpaceId}/chats/{chatId}/events
- get
  Retrieves a chat's events
/apispaces/{apiSpaceId}/chats/{chatId}/messages
- post
  Sends a message to chat
- get
  Retrieves a chat's messages from an point (event) in time and works backwards
/apispaces/{apiSpaceId}/chats/{chatId}/messages/statusupdates
- post
  Posts message updates back

Chat Presence API

/apispaces/{apiSpaceId}/presence
- get
  Retrieves the presence for a list of agent's profileIds
/apispaces/{apiSpaceId}/presence/away
- post
  Sets the profile identified in the JWT to be 'away'
- delete
  Sets the profile identified in the JWT to be available
/apispaces/{apiSpaceId}/presence/appmessaging
- get
  Retrieves the presence for a list of user's profileIds

Chat Config API

/apispaces/{apiSpaceId}/chat/config
- get
  Retrieves the chat configuration for an apiSpace
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}
- get
  Retrieves the members of a team
- delete
  Removes the config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/sms
- put
  Update the SMS config for a team
- delete
  Removes the SMS config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/fbMessenger
- put
  Update the Facebook Messenger config for a team
- delete
  Removes the Facebook Messenger config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/appMessaging
- put
  Update the App Messaging config for a team
- delete
  Removes the App Messaging config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/email
- put
  Update the email config for a team
- delete
  Removes the email config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/settings
- put
  Update general settings for a team
- delete
  Removes the settings for a team

Reference

MIME Types