Send Async Message

POST https://{{axpAPIDomain}}/api/digital/custom-messaging/v1/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.

Request Body

{"channelId"=>"Messaging", "channelProviderId"=>"{{digitalChannelProviderId}}", "businessAccountName"=>"{{digitalBusinessAccountName}}", "customerIdentifiers"=>{"emailAddresses"=>["john@company.com"], "phoneNumbers"=>["+91 20 4101 8003"]}, "body"=>{"elementType"=>"text", "elementText"=>{"text"=>"I need some help to sell my car", "textFormat"=>"PLAINTEXT"}}, "senderName"=>"John Doe", "providerSenderId"=>"PROVIDER_SENDER_ID", "providerDialogId"=>"{{digitalProviderDialogId}}", "providerMessageId"=>"PROVIDER_MESSAGE_ID", "customData"=>{"sentiment"=>"neutral"}, "engagementParameters"=>{"model"=>"512GTB", "interestedModel"=>"488GTB"}}

HEADERS

Key	Datatype	Required	Description
`appkey`	string
`Content-Type`	string
`Accept`	string

RESPONSES

status: OK

{&quot;messageId&quot;:&quot;f314569c-710b-11eb-9439-0242ac130002&quot;,&quot;accountId&quot;:&quot;DYNNUG&quot;,&quot;dialogId&quot;:&quot;fc741b00-710b-11eb-9439-0242ac130002&quot;,&quot;engagementId&quot;:&quot;8d7cf5b8-70ad-11eb-9439-0242ac130002&quot;,&quot;status&quot;:&quot;DELIVERED&quot;,&quot;sessionId&quot;:&quot;10494b78-710c-11eb-9439-0242ac130002&quot;,&quot;businessAccountName&quot;:&quot;e94e278d-72e7-48cc-80fc-dba9f8dd1c36&quot;,&quot;customerIdentifiers&quot;:{&quot;emailAddresses&quot;:[&quot;john@company.com&quot;],&quot;phoneNumbers&quot;:[&quot;+91 20 4101 8003&quot;]},&quot;channelProviderId&quot;:&quot;591c2529-c3a3-4062-a213-b239c18f543b&quot;,&quot;channelId&quot;:&quot;Messaging&quot;,&quot;senderParticipantId&quot;:&quot;277cacfe-710c-11eb-9439-0242ac130002&quot;,&quot;senderParticipantName&quot;:&quot;John Doe&quot;,&quot;senderParticipantType&quot;:&quot;AGENT&quot;,&quot;body&quot;:{&quot;elementType&quot;:&quot;text&quot;,&quot;elementText&quot;:{&quot;text&quot;:&quot;I need some help to sell my car&quot;,&quot;textFormat&quot;:&quot;PLAINTEXT&quot;}},&quot;customData&quot;:{&quot;sentiment&quot;:&quot;Neutral&quot;},&quot;messageIndex&quot;:0,&quot;parentMessageId&quot;:&quot;5963c0d619a30a2e00de36b8&quot;,&quot;providerDialogId&quot;:&quot;ed7e49dc8458c71d1d2f1e31&quot;,&quot;providerSenderId&quot;:&quot;d29c456135dcbe326e490bb2&quot;,&quot;providerMessageId&quot;:&quot;611c9a6a4a250100d4bd2c54&quot;,&quot;providerParentMessageId&quot;:&quot;611c9a6a4a250100d4bd2c54&quot;,&quot;engagementParameters&quot;:{&quot;model&quot;:&quot;512GTB&quot;,&quot;interestedModel&quot;:&quot;488GTB&quot;},&quot;receivedAt&quot;:&quot;2018-11-13T20:25:39.534Z&quot;,&quot;lastUpdatedAt&quot;:&quot;2018-11-13T20:25:39.734Z&quot;,&quot;correlationId&quot;:&quot;zc38400d-c44f-4451-8316-e75c4efbt779&quot;}