Send Message

post

{protocol}://{server}/api/digital/channel/v1beta/accounts/{accountId}/engagements/{engagementId}/messages

Send messages to the Contact Center.

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.

engagementId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the engagement.

Body Params

request

sessionId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character id (uuid) that represents the users session.

dialogId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the dialog.

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

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

senderParticipantName

string

length ≤ 70

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

parentMessageId

string

length ≤ 256

The unique 36 character internal id for the message that is the parent of this message

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

correlationId

string

length ≤ 256

The correlation id is used to uniquely identify the client request. This is an optional field but when specified can be used to correlate the callback event with the original API request. If the client does not pass any value for the correlation id in the request, a unique value will be generated automatically and sent back in the response.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Bad Request

401Unauthorized.

403Forbidden.

404Not Found.

500Internal Server Error