Avaya Infinity™Avaya Experience Platform™
Engagement API Version Differences
These docs are for v0.0.1. Click to read the latest docs for v1.0.63.

Engagement API Version Differences

New Field Renamed Field Deleted Field

Engagement APIs

Summary of changes:

  • The path has changed (base path + API path). "accountId" is mandatory in path of each API
  • "channelProviderId", "customerIdentifiers", "participantId" not required to be provided in Engagement APIs as the values will be derived from session object referenced by "sessionId"
  • Timestamps have changed from Epoch timestamp (int64) to 'yyyy-MM-dd'T'HH:mm:ss[.SSS]Z' format
  • Few fields renamed, added or removed in request and response payload to make the data more consistent

API Version /v1 /v1beta
Base Path https://HOST-REGION.cc.avayacloud.com/api/digital https://HOST-REGION.cc.avayacloud.com/api/digital/channel

Create Engagement

POST  /v1/engagements

POST  /v1beta/accounts/ {accountId} /engagements


Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y

Request Payload sessionId


sessionId Y

accountId

Shifted to path parameter



mediaType


channelId
Y

conversation


conversation



correlationId


correlationId


contextParameters


engagementParameters

Renamed Field

providerDialogId

providerDialogId


channelProviderId
Information was already provided while creating session



customerIdentifier
Information was already provided while creating session




Response

Refer to Create Engagement Response model


Sample Request

 
                                {
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779",
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"accountId": "DYNNUG",
"customerIdentifier": "[email protected]",
"conversation": "sell car",
"channelProviderId": "ChatConnector01",
"providerDialogId": "616imlgwg266hjs670nl",
"mediaType": "CHAT",
"contextParameters": {
"model": "512GTB",
"interestedModel": "488GTB"
}
}
                            
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"channelId": "Chat",
"conversation": "sell car",
"providerDialogId": "616imlgwg266hjs670nl",
"engagementParameters": {
"model": "512GTB",
"interestedModel": "488GTB"
},
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779"
}

Sample Response

Refer to Sample Create Engagement response


List Engagements

GET /v1/engagements


GET /v1beta/accounts/ {accountId} /engagements



Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y

Response Refer to Engagement Response model

Sample response Refer to Sample List Engagement Response

Get Engagement

GET  /v1/engagements/ {engagementId}

GET  /v1beta/accounts/ {accountId} /engagements/ {engagementId}


Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y
engagementId Y
engagementId Y

Response Refer to Engagement Response model
Sample response Refer to Sample Get Engagement response

Disconnect Engagement

POST  /v1/engagements/ {engagementId} :disconnect

POST  /v1beta/accounts/ {accountId} /engagements/ {engagementId} :disconnect


Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y
engagementId Y
engagementId Y

Request Payload

Refer to Disconnect Engagement response


Response 200 OK 200 OK

Sample Request 
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
"reason": "USER_DISCONNECTED"
}
                            
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"reason": "USER_CLOSED",
"correlationId": "cdf184ec-8278-11eb-8dcd-0242ac130003"
}
Sample Response


No response object. 

                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"reason": "USER_CLOSED",
"correlationId": "cdf184ec-8278-11eb-8dcd-0242ac130003"
}

Join Engagement

POST  /v1/engagements/{engagementId}:join

POST  /v1beta/accounts/{accountId}/engagements/{engagementId}:join


Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y
engagementId Y
engagementId Y

Request Payload

Refer to Join Engagement


Response

Refer to Engagement Response model


Sample Request 
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"customerIdentifier": "d2ac3a72-8278-11eb-8dcd-0242ac130003"
}
                            
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"correlationId": "d2ac3a72-8278-11eb-8dcd-0242ac130003"
}
Sample Response

Refer to Sample Get Engagement response


Send Message

POST  /v1/engagements/{engagementId}/messages

POST  /v1beta/accounts/{accountId}/engagements/{engagementId}/messages


Fields Mandatory Comment Fields Mandatory Comment
Path Parameters


accountId Y
engagementId Y
engagementId Y

Request Payload Refer to Send Message

Response Refer to Message response

Sample Request 
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"body": {
"elementType": "text",
"elementText": {
  "text": "I need some help to sell my car"
}
},
"correlationId": "CORQ8fk4oAWV997",
"senderName": "John Doe",
"senderType": "CUSTOMER"
}
                            
                                {
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"body": {
"elementType": "text",
"elementText": {
  "text": "I need some help to sell my car"
}
},
"senderParticipantName": "John Doe",
"correlationId": "CORQ8fk4oAWV997"
}

Sample Response Refer to Sample Send Message response

Get/List Messages

GET  /v1/engagements/ {engagementId} /messages

GET  /v1beta/accounts/ {accountId} /engagements/ {engagementId} /messages

Path Parameters


accountId Y
engagementId Y
engagementId Y

Query Paramaters dialogId Y
dialogId Y
sessionId Y
sessionId Y



pageSize
Default : 10



pageNumber
Default : 1

Response Refer to /v1 Message Refer to MessagePage

Sample Response

Refer to Sample Get Message response


Retrieve notification events

GET  /v1/engagements/ {engagementId} /notifications

Not supported in /v1beta

Comparison of /v1 and /v1beta models

Create Engagement Response model

Model

/v1

/v1beta

Model Name EngagementCreated Engagement

Response model 		engagementId


engagementId
Y
accountId


accountId


conversation


conversation Y
correlationId

correlationId

mediType
Moved to Dialog > channelId url Y
dialogId

Moved to Dialog > dialogId dialogs Y Array of Dialog Model
sessionId

Moved to Dialog > Connection > sessionIds


customerIdentifier


Removed


createTimeMillis

Moved to Dialog > createdAt


providerDialogId
Moved to Dialog > providerDialogId


Engagement Response model

Model

/v1

/v1beta

Model Name Engagement Engagement

Response model 		engagementId


engagementId
Y
accountId


accountId
Y
conversation


conversation

uri

url Y
dialogs

Array of /v1 Dialog Model dialogs Y Array of /v1beta Dialog Model
correlationId
Removed correlationId

customerIdentifier
Removed


engagementStatus
Refer Dialog > dialogStatus


createTimeMillis


Moved to Dialog > createdAt



updateTimeMillis
Moved to Dialog > lastUpdatedAt


Dialog Model

API Version /v1

/v1beta
Model Name Dialog

Dialog

Field Mandatory Comments Field Mandatory? Comments
1 dialogId

dialogId Y
2 dialogStatus

dialogStatus Y PENDING, ACTIVE, TERMINATING, TERMINATED
3 mediaType

channelId Y
4 sourceParticipantId

initiatorParticipantId Y
5 connections
Array of /v1 Participant
Object 		connections Y Array of /v1beta Connection Model
6 contextParameters

engagementParameters

7


createdAt Y
8


lastUpdatedAt Y
9 providerDialogId

providerDialogId

/v1 Participant Model


Field Mandatory Enum values
1 connectionId Y
2 participantId Y
3 displayName Y
4 sessionIds

5 participantType
CUSTOMER, AGENT, SUPERVISOR, SYSTEM, BOT
6 connectionState
ACTIVE, INACTIVE, DISCONNECTED
7 participantMode
PUBLIC, WHISPER_ONLY, LISTEN_ONLY
8 metadata

/v1beta Connection Model


 Field Mandatory Enum values
1 connectionId Y
2 participantId Y
3 participantType Y CUSTOMER, AGENT, SUPERVISOR, SYSTEM, BOT
4 displayName

5 sessionIds

6 connectionState Y CONNECTED, DISCONNECTED

DisconnectEngagement

API Version /v1 /v1beta
Model Name DisconnectEngagement DisconnectEngagement

Field Mandatory Comments Field Mandatory? Comments
1 sessionId


sessionId
Y
2 dialogId


dialogId
Y
3 reason
UNKNOWN, USER_DISCONNECTED, USER_CLOSED, USER_INACTIVE, SYSTEM_CLOSED reason
USER_CLOSED, USER_INACTIVE, SYSTEM_CLOSED, UNKNOWN
4 participantId
Derived from sessionId correlationId

JoinEngagement

API Version /v1 /v1beta
Model Name JoinEngagement
JoinEngagement

Field Mandatory Comments Field Mandatory? Comments
1 sessionId


sessionId
Y
2 dialogId


dialogId
Y
3 customerIdentifier

Derived from sessionId correlationId


SendMessage

API Version /v1 /v1beta

SendMessage
SendMessage

Field Mandatory Comments Field Mandatory? Comments
1 correlationId

correlationId

2 parentMessageId

parentMessageId


3 providerMessageId

providerMessageId

4 providerParentMessageId html

providerParentMessageId

5 sessionId Y
sessionId Y
6 dialogId Y
dialogId Y
7 body Y String body Y

Object of \v1beta BodyElement


8 senderName

senderParticipantName

9 fallbackText

fallbackText

10 headers
Object of MessageHeaders headers
Object of MessageHeaders
11 customData

customData

12 providerSenderId
Derived from sessionId (providerCustomerId)


13 senderType
Implicit value "CUSTOMER"


Message

API Version /v1 /v1beta
Model Name MessageEvent MessageEvent

Field Mandatory Comments Field Mandatory Comments
1 messageId Y
messageId

2 accountId

accountId Y
3 dialogId Y
dialogId

4 engagementId Y
engagementId

5 status Y
status Y
6 sessionId

sessionId

7 senderId

senderParticipantId Y
8 senderName

senderParticipantName Y
9 body
Object of BodyElement
body Y Object of BodyElement
10 attachments

attachments
Array of Attachment object
11 parentMessageId

parentMessageId

12 correlationId

correlationId

13 fallbackText


fallbackText

14 headers

Object of MessageHeaders headers
Object of MessageHeaders
15 createTimeMillis
Removed recipientParticipants
Array of Participant object
16 customData

Replaced with customData customData

17


messageIndex

18 senderType

senderParticipantType Y
19 businessAccountName Y
businessAccountName

20 channelProviderId Y
channelProviderId Y
21 channelId Y
channelId Y
22 providerDialogId

providerDialogId

23 providerSenderId

providerSenderId

24 providerMessageId

providerMessageId

25 providerParentMessageId

providerParentMessageId

26 contextParameters

engagementParameters

27 receivedTimestamp

receivedAt

28 lastUpdatedTimestamp

lastUpdatedAt

BodyElement

API Version /v1 /v1beta
Model Name BodyElement
BodyElement

Field Mandatory Comments Field Mandatory Comments
1 elementType Y
elementType Y
2 elementText
Object of Text elementText
Object of Text
3 payload

payload

Text (No Change)

API Version /v1 /v1beta
Model Name Text Text

Field Mandatory Comments Field Mandatory Comments
1 text Y
text Y
2 textFormat

Enum [ PLAINTEXT, .

HTML, MARKDOWN  ]

textFormat

Enum [ PLAINTEXT,

HTML, MARKDOWN  ]

MessageHeaders (No Change)

API Version /v1 /v1beta
Model Name MessageHeaders MessageHeaders

Field Mandatory Comments Field Mandatory Comments
1 priority

priority

2 sensitivity

sensitivity

3 encoding

encoding

4 subject

subject

5 from

from

6 to

to

7 cc

cc

8 bcc

bcc

9 replyTo

replyTo

10 clientDeviceTag

clientDeviceTag

11 messageSourceServerTag

messageSourceServerTag

12 providerTimestamp

providerTimestamp

13 additionalHeaders

additionalHeaders

Participant

API Version /v1 /v1beta
Model Name Participant Participant

Field Mandatory Comments Field Mandatory Comments
1 participantId Y
participantId Y
2 participantType Y

Enum [ CUSTOMER, AGENT,

SUPERVISOR, SYSTEM, BOT  ]

participantType Y

Enum [ CUSTOMER, AGENT,

SUPERVISOR, SYSTEM, BOT  ]

3 participantAddress
Simila providerParticipantId

4 connectionId

connectionId

5 displayName

displayName

6


channelProviderId

Attachment

API Version /v1 /v1beta
Model Name Attachment Attachment

Field Mandatory Comments Field Mandatory Comments
1 id Y
attachmentId

2 name Y
name Y
3 size Y
size Y
4 contentType Y
contentType Y
5 url Y
url Y
6 captionText

captionText

7 thumbnailUrl

thumbnailUrl

8 additionalProperties

additionalProperties

9


contentId

MessagePage

API Version /v1beta
Model Name MessagePage

Field Mandatory Comments
1 pagination
pagination
2 messages
Array of /v1beta Message object
3 links
Object of Links

Pagination

API Version /v1beta
Model Name Pagination

Field Mandatory Comments
1 prev

2 next

API Version /v1beta
Model Name Links

Field Mandatory Comments
1 pageNumber


2 pageSize


3 total


Sample Response for /v1 and /v1beta

Create Engagement

API Version /v1

/v1beta

Model Name EngagementCreated Engagement 

                                {
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "DYNNUG",
"customerIdentifier": "[email protected]",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"conversation": "sell car",
"providerDialogId": "616imlgwg266hjs670nl",
"mediaType": "CHAT",
"createTimeMillis": 1597432259,
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779"
}
                            
                                {
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "ABCDEF",
"conversation": "sell car",
"dialogs": [
{
  "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
  "channelId": "Chat",
  "dialogStatus": "PENDING",
  "providerDialogId": "616imlgwg266hjs670nl",
  "initiatorParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
  "connections": [
    {
      "connectionId": "zc38400d-c44f-4451-8316-e75c4efbt779",
      "participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
      "participantType": "CUSTOMER",
      "displayName": "John Doe",
      "sessionIds": [
        "10494b78-710c-11eb-9439-0242ac130002"
      ],
      "connectionState": "CONNECTED"
    },
    {
      "connectionId": "f3c8400d-c44f-4451-8316-e75c4efb8zz9",
      "participantId": "e3c8400d-c44f-4451-8316-e75c4efb8cc7",
      "participantType": "AGENT",
      "displayName": "Joan Doe",
      "connectionState": "CONNECTED"
    }
  ],
  "engagementParameters": {
    "model": "512GTB",
    "interestedModel": "488GTB"
  },
  "createdAt": "2018-11-13T20:25:39.534Z",
  "lastUpdatedAt": "2018-11-13T20:25:39.734Z"
}
],
"url": "https://us.cc.avayacloud.com/api/digital/channel/v1beta/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779"
}

List Engagement

API Version

/v1

/v1beta

Model Name Engagement Engagement 

                                [
{
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "ABCDEF",
"correlationId": "ENGWgCgAzlw1C51",
"customerIdentifier": "[email protected]",
"conversation": "sell car",
"dialogs": [
  {
    "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
    "mediaType": "CHAT",
    "dialogStatus": "CREATED",
    "providerDialogId": "616imlgwg266hjs670nl",
    "sourceParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
    "connections": [
      {
        "connectionId": "f3c8400d-c44f-4451-8316-e75c4efb8zz9",
        "participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
        "displayName": "John Doe",
        "sessionIds": [
          "10494b78-710c-11eb-9439-0242ac130002"
        ],
        "participantType": "CUSTOMER",
        "participantMode": "PUBLIC",
        "connectionState": "ACTIVE",
        "metadata": {}
      }
    ],
    "contextParameters": {
      "model": "512GTB",
      "interestedModel": "488GTB"
    }
  }
],
"engagementStatus": "ACTIVE",
"createTimeMillis": 1597260762,
"updateTimeMillis": 1597260762,
"uri": "/v1/digital/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2"
}
]
                            
                                [
{
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "ABCDEF",
"conversation": "sell car",
"dialogs": [
  {
    "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
    "channelId": "Chat",
    "dialogStatus": "ACTIVE",
    "providerDialogId": "616imlgwg266hjs670nl",
    "initiatorParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
    "connections": [
      {
        "connectionId": "zc38400d-c44f-4451-8316-e75c4efbt779",
        "participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
        "participantType": "CUSTOMER",
        "displayName": "John Doe",
        "sessionIds": [
          "10494b78-710c-11eb-9439-0242ac130002"
        ],
        "connectionState": "CONNECTED"
      },
      {
        "connectionId": "f3c8400d-c44f-4451-8316-e75c4efb8zz9",
        "participantId": "e3c8400d-c44f-4451-8316-e75c4efb8cc7",
        "participantType": "AGENT",
        "displayName": "Joan Doe",
        "connectionState": "CONNECTED"
      }
    ],
    "engagementParameters": {
      "model": "512GTB",
      "interestedModel": "488GTB"
    },
    "createdAt": "2018-11-13T20:25:39.534Z",
    "lastUpdatedAt": "2018-11-13T20:25:39.34Z"
  }
],
"url": "https://us.cc.avayacloud.com/api/digital/channel/v1beta/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2"
}
]

GET Engagement

API Version

/v1

/v1beta

Model Name Engagement Engagement 

                                {
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "ABCDEF",
"correlationId": "ENGWgCgAzlw1C51",
"customerIdentifier": "[email protected]",
"conversation": "sell car",
"dialogs": [
  {
    "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
    "mediaType": "CHAT",
    "dialogStatus": "CREATED",
    "providerDialogId": "616imlgwg266hjs670nl",
    "sourceParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
    "connections": [
      {
        "connectionId": "f3c8400d-c44f-4451-8316-e75c4efb8zz9",
        "participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
        "displayName": "John Doe",
        "sessionIds": [
          "10494b78-710c-11eb-9439-0242ac130002"
        ],
        "participantType": "CUSTOMER",
        "participantMode": "PUBLIC",
        "connectionState": "ACTIVE",
        "metadata": {}
      }
    ],
    "contextParameters": {
      "model": "512GTB",
      "interestedModel": "488GTB"
    }
  }
],
"engagementStatus": "ACTIVE",
"createTimeMillis": 1597260762,
"updateTimeMillis": 1597260762,
"uri": "/v1/digital/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2"
}
                            
                                {
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"accountId": "ABCDEF",
"conversation": "sell car",
"dialogs": [
  {
    "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
    "channelId": "Chat",
    "dialogStatus": "ACTIVE",
    "providerDialogId": "616imlgwg266hjs670nl",
    "initiatorParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
    "connections": [
      {
        "connectionId": "zc38400d-c44f-4451-8316-e75c4efbt779",
        "participantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
        "participantType": "CUSTOMER",
        "displayName": "John Doe",
        "sessionIds": [
          "10494b78-710c-11eb-9439-0242ac130002"
        ],
        "connectionState": "CONNECTED"
      },
      {
        "connectionId": "f3c8400d-c44f-4451-8316-e75c4efb8zz9",
        "participantId": "e3c8400d-c44f-4451-8316-e75c4efb8cc7",
        "participantType": "AGENT",
        "displayName": "Joan Doe",
        "connectionState": "CONNECTED"
      }
    ],
    "engagementParameters": {
      "model": "512GTB",
      "interestedModel": "488GTB"
    },
    "createdAt": "2018-11-13T20:25:39.534Z",
    "lastUpdatedAt": "2018-11-13T20:25:39.34Z"
  }
],
"url": "https://us.cc.avayacloud.com/api/digital/channel/v1beta/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2"
}

Send Message

API Version

/v1

/v1beta

Model Name Message Message 

                                {
"accountId": "ABCDEF",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"status": "QUEUED",
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"senderName": "John Doe",
"senderType": "CUSTOMER",
"body": {
"elementType": "text",
"elementText": {
  "text": "I need some help to sell my car",
  "textFormat": "PLAINTEXT"
}
},
"providerDialogId": "616imlgwg266hjs670nl",
"receivedTimestamp": 1597433717833,
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779",

}
                            
                                {
"accountId": "ABCDEF",
"dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
"engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
"status": "SENT",
"sessionId": "10494b78-710c-11eb-9439-0242ac130002",
"businessAccountName": "[email protected]",
"channelProviderId": "ChatConnector01",
"channelId": "Chat",
"senderParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
"senderParticipantName": "John Doe",
"senderParticipantType": "CUSTOMER",
"body": {
"elementType": "text",
"elementText": {
  "text": "I need some help to sell my car",
  "textFormat": "PLAINTEXT"
}
},
"messageIndex": 1,
"providerDialogId": "616imlgwg266hjs670nl",
"receivedAt": "2018-11-13T20:25:39.534Z",
"lastUpdatedAt": "2018-11-13T20:25:39.834Z",
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779"
}

Get Message

API Version

/v1

/v1beta

Model Name Message MessagePage 

                                [
{
"messageId": "f314569c-710b-11eb-9439-0242ac130002",
"accountId": "ABCDEF",
"dialogId": "10494b78-710c-11eb-9439-0242ac130002",
"engagementId": "775228c9-4bfe-4757-9af6-eda7562e935a",
"status": "DELIVERED",
"sessionId": "233e1485-8cdf-4860-ac94-d2aa37c1f86e",
"businessAccountName": "[email protected]",
"channelProviderId": "ChatConnector01",
"channelId": "CHAT",
"senderId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
"senderName": "John Doe",
"senderType": "CUSTOMER",
"body": {
  "elementType": "text",
  "elementText": {
    "text": "I need some help to sell my car",
    "textFormat": "PLAINTEXT"
  }
},
"customData": {
  "sentiment": "Neutral"
},
"parentMessageId": "5963c0d619a30a2e00de36b8",
"providerDialogId": "616imlgwg266hjs670nl",
"providerSenderId": "jd4einqsjc",
"providerMessageId": "iwrh1hfbkmj4yb36ijsm",
"providerParentMessageId": "bgodcec6a9kvn38g46sn",
"receivedTimestamp": 1597433717851,
"lastUpdatedTimestamp": 1597433717851,
"correlationId": "zc38400d-c44f-4451-8316-e75c4efbt779"
}
]
                            
                                {
"pagination": {
"pageNumber": 1,
"pageSize": 5,
"total": 7
},
"messages": [
{
  "messageId": "f314569c-710b-11eb-9439-0242ac130002",
  "accountId": "ABCDEF",
  "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
  "engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
  "status": "DELIVERED",
  "sessionId": "10494b78-710c-11eb-9439-0242ac130002",
  "businessAccountName": "[email protected]",
  "channelProviderId": "ChatConnector01",
  "channelId": "Chat",
  "senderParticipantId": "4dc53692-e25c-4e8c-a780-0b2f05008478",
  "senderParticipantName": "John Doe",
  "senderParticipantType": "CUSTOMER",
  "body": {
    "elementType": "text",
    "elementText": {
      "text": "I need some help to sell my car",
      "textFormat": "PLAINTEXT"
    }
  },
  "customData": {
    "sentiment": "Neutral"
  },
  "messageIndex": 1,
  "parentMessageId": "5963c0d619a30a2e00de36b8",
  "providerDialogId": "616imlgwg266hjs670nl",
  "providerSenderId": "jd4einqsjc",
  "providerMessageId": "iwrh1hfbkmj4yb36ijsm",
  "providerParentMessageId": "bgodcec6a9kvn38g46sn",
  "receivedAt": "2018-11-13T20:25:39.534Z",
  "lastUpdatedAt": "2018-11-13T20:25:39.834Z"
},
{
  "messageId": "f314569c-710b-11eb-9439-0242ac130002",
  "accountId": "ABCDEF",
  "dialogId": "fc741b00-710b-11eb-9439-0242ac130002",
  "engagementId": "d3c8400d-c44f-4451-8316-435ch8c6e3f2",
  "status": "DELIVERED",
  "businessAccountName": "[email protected]",
  "channelProviderId": "ChatConnector01",
  "channelId": "Chat",
  "senderParticipantId": "e3c8400d-c44f-4451-8316-e75c4efb8cc7",
  "senderParticipantName": "Joan Doe",
  "senderParticipantType": "AGENT",
  "body": {
    "elementType": "text",
    "elementText": {
      "text": "Sure. How long have you been using it?",
      "textFormat": "PLAINTEXT"
    }
  },
  "customData": {
    "sentiment": "Neutral"
  },
  "messageIndex": 2,
  "parentMessageId": "f26c65ec-ed40-4e9e-9a96-45a089c2107c",
  "providerDialogId": "616imlgwg266hjs670nl",
  "receivedAt": "2018-11-13T20:25:39.534Z",
  "lastUpdatedAt": "2018-11-13T20:25:39.834Z"
}
],
"links": {
"prev": "",
"next": "/api/digital/channel/v1beta/engagements/d3c8400d-c44f-4451-8316-435ch8c6e3f2/messages?sessionId=10494b78-710c-11eb-9439-0242ac130002&dialogId=fc741b00-710b-11eb-9439-0242ac130002&pageSize=2&pageNumber=21&pageSize=5"
}
}