Send Async Message

post

{protocol}://{server}{basePath}/accounts/{accountId}/messages

Sends messages related to an asynchronous or long lived communication to the contact center. Messages sent with same 'providerDialogId' are considered part of same the conversation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Body Params

channelProviderId

string

required

length between 3 and 256

The unique id that represents the channel provider

channelId

string

required

length between 3 and 50

The unique id representing the Contact Center Channel. Only valid Contact Center Channel Id's are accepted. See Contact Center Channel list in Developers guide for further details.

businessAccountName

string

required

length between 3 and 256

The name of the business account configured on the channel provider. For custom messaging integration, provide the unique id of the integration (integrationId) here.

customerIdentifiers

object

required

Unique identifiers for identifying the customer during an Engagement such as phoneNumbers or emailAddresses.

senderName

string

length ≤ 70

The optional display name of the user that sent the message. If not provided, display name from the session will be used.

providerSenderId

string

length ≤ 256

The provider side identifier for the user who sent the message.

providerDialogId

string

length ≤ 256

The provider side identifier for a Contact Center dialog. Messages with same 'providerDialogId' value are considered part of same conversation. If no or blank value is passed, this message will be treated as a new individual dialog

providerMessageId

string

length ≤ 256

The provider side identifier for the message.

providerParentMessageId

string

length ≤ 256

The provider side identifier for the message that is the parent of this message

body

object

required

Definition of the body element such as the type of element, the message text and format

fallbackText

string

length ≤ 256

Fallback message text that clients can show if they are not capable of rendering the body

headers

object

The header of the message

attachments

array of objects

length ≤ 25

attachments

customData

object

Any data complementing the actual message body that is valuable for recipient clients. For example any additional reference links, key words, hash tag references, additional content information etc. Key is limited to 64 characters

engagementParameters

object

Optional key/value context information on the engagement. This information might be used to make business decisions on how the engagement is treated. For example, the client application might want to send hints about customer's interest based on the customer's searches or FAQ browsing. Key is limited to 64 characters

correlationId

string

length ≤ 256

The correlation id can be used to uniquely identify the client request. This is an optional field but when specified it will be included in any callback events and can be used to correlate the callback event with the original API request.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses