List Messages

GET https://{{axpAPIDomain}}/api/digital/transcript/v1/accounts/:accountId/engagements/:engagementId/messages?pageNumber=1&pageSize=10

Retrieve transcript messages for all dialogs of a given engagement.

Request Params

HEADERS

RESPONSES

status: OK

{"pagination":{"pageNumber":3,"pageSize":15,"total":60},"messages":[{"accountId":"ZWJJIQ","dialogId":"bb4f5cf8-5bfc-4bf3-ac43-153c43671f0e","engagementId":"bb4f5cf8-5bfc-4bf3-ac43-153c43671f0e","messageId":"774f5cf8-5bfc-4bf3-ac43-153c43671f04","messageIndex":1,"channelId":"EMAIL","messageType":"REPLY","messageDirection":"INCOMING","providerDialogId":"bb4f5cf8-5bfc-4bf3-ac43-153c43671f0e","providerMessageId":"774f5cf8-5bfc-4bf3-ac43-153c43671f04","privateMessage":false,"body":{"elementType":"TEXT","payload":"message text content","elementText":{"text":"this is text content of the message","textFormat":"PLAINTEXT"}},"header":{"priority":"important","sensitivity":"sensetive","encoding":"utf-8","subject":"Title of the message","from":"email1@email.com","to":["email2@email.com"],"cc":["email3@email.com"],"bcc":["email4@email.com"],"replyTo":"email2@email.com","providerMessageTimestamp":"2023-11-16T05:57:44.000Z","messageSourceServerTag":"Tag1","clientDeviceTag":"ios-device-1","additionalHeaders":{"header1":"added property"}},"parts":[{"partId":"774f5cf8-5bfc-4bf3-ac43-153c43671f04","name":"file.png","contentType":"application/text","size":3500,"url":"https://service-domain.com/file.png","captionText":"Image showing and issue","thumbnailUrl":"https://somedomain.com/thumb.png","additionalProperties":{"property1":"added properties"}}],"messageReceivedTimestamp":"2023-11-16T05:57:44.000Z","senderParticipantName":"shane","senderParticipantType":"CUSTOMER","sourceType":"Facebook"}],"links":{"prev":"/api/digital/transcript/v1/accounts/{accountId}/engagements/{engagementId}/messages?pageNumber=2\u0026pageSize=15","next":"/api/digital/transcript/v1/accounts/{accountId}/engagements/{engagementId}/messages?pageNumber=4\u0026pageSize=15"}}