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 StartedTutorialsReferenceReferenceChangelogCommunityPage 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}
- postPosts a status for a message
/apispaces/{apiSpaceId}/messages/{messageId}
/apispaces/{apiSpaceId}/messages
- postSend a new message
/apispaces/{apiSpaceId}/messages/batch
- postSend a batch of new messages
/apispaces/{apiSpaceId}/messages/inbounds
- postPosts an inbound message
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}
/apispaces/{apiSpaceId}/messages/mirror/{channel}
- postCreates a mirror of a batch of messages sent directly by a channel
/apispaces/{apiSpaceId}/messages/status/{channel}
- postLoads a batch of status changes for messages sent directly by a channel
/apispaces/{apiSpaceId}/messages/inbounds/{inboundMessageId}/statuses/{status}
- postPosts a status for an inbound

Message History API

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

Content API

/apispaces/{apiSpaceId}/content/{fileId}
- getRetrieve a file

Profile API

/apispaces/{apiSpaceId}/profiles/export
- postExports the result of a profile query in a formatted file for download
/apispaces/{apiSpaceId}/profiles/bulk
- patchCreates or updates the supplied profiles with the supplied data
- deleteDeletes the requested profiles
/apispaces/{apiSpaceId}/profiles/{id}
/apispaces/{apiSpaceId}/profiles/{id}/optin
- putSet profile opt in for specified channels
- deleteSet profile opt in for specified channels
/apispaces/{apiSpaceId}/profiles/{id}/rels/primary/{linkedId}
- putCreates a relationship where the linked profile is the primary and this profile is a child
- deleteDeletes the profile's relationship to a primary profile
/apispaces/{apiSpaceId}/profiles/{id}/rels/link/{linkedId}
- putCreates a relationship where this profile is the primary and the linked profile is a child
- deleteDeletes the primary profile's relationship to a linked Profile
/apispaces/{apiSpaceId}/profiles
- getQuery profiles
- postCreates a new Profile
/apispaces/{apiSpaceId}/profiles/import
- postStart the import process
/apispaces/{apiSpaceId}/profiles/optin
- getGets default profiles opt in/out options for each channel in channel service
- putSet default profiles opt in/out options for each channel in channel service
/apispaces/{apiSpaceId}/profiles/import/{id}/duplicates
- getGet information about duplicated profiles
/apispaces/{apiSpaceId}/profiles/import/{id}/start
- putStart the import process
/apispaces/{apiSpaceId}/audiences/{id}
/apispaces/{apiSpaceId}/audiences
- getQuery audience
- postCreates a new audience

Conversation API

/apispaces/{apiSpaceId}/conversations/{conversationId}
/apispaces/{apiSpaceId}/conversations
- postCreates a new conversation
- getRetrieves a list of conversations
/apispaces/{apiSpaceId}/conversations/{conversationId}/typing
- postIndicates that the caller is typing in this conversation
- deleteIndicates that the caller has stopped typing in this conversation
/apispaces/{apiSpaceId}/conversations/{conversationId}/participants

Conversation Message API

/apispaces/{apiSpaceId}/conversations/{conversationId}/events
- getRetrieves a conversation's events
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages
- postSends a message to conversation
- getRetrieves a conversation's messages from an point (event) in time and works backwards
/apispaces/{apiSpaceId}/conversations/{conversationId}/messages/statusupdates
- postPosts message updates back

Analytics API

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

Comapi Facebook API

post
Facebook Meta Data Service

Comapi Integrator API

get
Getting Message Statuses
get
Profile Schema Retrieval
post
Authenticate

API Space Management API

/apispaces/{id}
/apispaces
- getRetrieves all API Spaces accessible by the current user
- postCreates a new API Space
/apispaces/{id}/auth
- getRetrieves an API Space's authentication configuration
- putUpdates an API Space's authentication configuration
/apispaces/{id}/push
- getRetrieves an API Space's push configuration
/apispaces/{id}/retention
- getRetrieves an API Space's data retention configuration
- putUpdates an API Space's data retention configuration
/apispaces/{id}/push/apns
- putUpdates an API Space's APNS push certificate configuration
/apispaces/{id}/push/apns/{bundleId}/{environment}
- deleteDeletes a specific bundle from an API Space's APNS push configuration
/apispaces/{id}/push/apns/{bundleId}/{environment}/cert
- getRetrieves a bundle's APNS certificate
/apispaces/{id}/push/apnstoken
- putUpdates an API Space's APNS push token configuration
- deleteDeletes the APNS push token configuration from an API Space's APNS push configuration
/apispaces/{id}/push/apnstoken/key
- getRetrieves the APNS key file for the API Space
/apispaces/{id}/push/fcm/{package}
- putUpdates an API Space's FCM push configuration
- deleteDeletes a specific package from an API Space's FCM push configuration

Billing API

/accounts/{accountId}/tariff
- getRetrieves an account's tariff
/accounts/{accountId}/transactions
- getRetrieves 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
- getRetrieves a prepay account's wallet balance

Session API

/apispaces/{apiSpaceId}/sessions/tokens/anon
- getGets a token that can be used to start an anonymous session
/apispaces/{apiSpaceId}/sessions/{id}
- getRetrieves details about a session
- deleteEnds a session, revoking access to services.

Webhook API

/apispaces/{apiSpaceId}/webhooks
- getRetrieves a webhook configuration
- postCreate a webhook configuration
/apispaces/{apiSpaceId}/webhooks/availableevents
- getRetrieves a webhook available events
/apispaces/{apiSpaceId}/accesstokens/availabletemplates
- getGets a list of available events templates that the caller can use when creating webhook
/apispaces/{apiSpaceId}/webhooks/{webhookId}

Chat API

/apispaces/{apiSpaceId}/chats/{chatId}
/apispaces/{apiSpaceId}/chats/{chatId}/assign
- putAssigns a chat
/apispaces/{apiSpaceId}/chats/{chatId}/close
- putCloses a chat
/apispaces/{apiSpaceId}/chats/{chatId}/channel
- putChanges the channel for an existing chat
/apispaces/{apiSpaceId}/chats/{chatId}/form
- postSends a form to a chat
/apispaces/{apiSpaceId}/chats
- postCreates a new chat
- getRetrieves a list of chats
/apispaces/{apiSpaceId}/chats/{chatId}/typing
- postIndicates that the caller is typing in this chat
- deleteIndicates that the caller has stopped typing in this chat
/apispaces/{apiSpaceId}/chats/{chatId}/participants
- getRetrieves the chat participants

Chat Message API

/apispaces/{apiSpaceId}/chats/{chatId}/events
- getRetrieves a chat's events
/apispaces/{apiSpaceId}/chats/{chatId}/messages
- postSends a message to chat
- getRetrieves a chat's messages from an point (event) in time and works backwards
/apispaces/{apiSpaceId}/chats/{chatId}/messages/statusupdates
- postPosts message updates back

Chat Presence API

/apispaces/{apiSpaceId}/presence
- getRetrieves the presence for a list of agent's profileIds
/apispaces/{apiSpaceId}/presence/away
- postSets the profile identified in the JWT to be 'away'
- deleteSets the profile identified in the JWT to be available
/apispaces/{apiSpaceId}/presence/appmessaging
- getRetrieves the presence for a list of user's profileIds

Chat Config API

/apispaces/{apiSpaceId}/chat/config
- getRetrieves the chat configuration for an apiSpace
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}
- getRetrieves the members of a team
- deleteRemoves the config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/sms
- putUpdate the SMS config for a team
- deleteRemoves the SMS config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/fbMessenger
- putUpdate the Facebook Messenger config for a team
- deleteRemoves the Facebook Messenger config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/appMessaging
- putUpdate the App Messaging config for a team
- deleteRemoves the App Messaging config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/email
- putUpdate the email config for a team
- deleteRemoves the email config for a team
/apispaces/{apiSpaceId}/chat/config/teams/{teamId}/settings
- putUpdate general settings for a team
- deleteRemoves the settings for a team

Reference

MIME Types