POST API/V40/Interactive/Messages/Conversations

Create conversation

Request Information

URI Parameters

None.

Body Parameters

The request model

CreateConversationRequest
NameDescriptionTypeAdditional information
Message

The initial message in the conversation

 string

ConversationType

Defines how conversation is created. Can be either empty or "guest". If "guest" then the guest's name will be used as message creator.

 string

OutletCode

Outlet this conversation is connected to. Field is optional, but if left empty then the first available outlet will be selected.

 string

OrderCode

Order this conversation is connected to. Field is optional.

 string

SessionToken

The token associated with this session of API interactions. This token should always be included in API calls, because it contains important session state information.

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "message": "sample string 1",
  "conversationType": "sample string 2",
  "outletCode": "sample string 3",
  "orderCode": "sample string 4",
  "sessionToken": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel
NameDescriptionTypeAdditional information
SessionToken

The token associated with this session of API interactions. Generally this is the same token passed with the API request parameters, but under certain circumstances this can be changed before being sent back to the caller.

 string

ResponsesIncluded

A list of response messages names contained in this composite message, for easy pre-parsing.

 string

Responses

A list of response messages contained in this composite message.

 Collection of Object

Status

The success status the composite message.

 CompositeStatus

Response Formats

application/json, text/json

Sample: 
{
  "sessionToken": "2_030zwU3YgKAAAAAAAAAAAAAAA.czayt-HW5HIm7XtJnkqdiE__6HXtL3Pghk41FONV5bY",
  "responsesIncluded": "createConversationResponse",
  "responses": [
    {
      "createConversationResponse": {
        "content": {
          "conversation": {
            "code": "sample string 1",
            "subject": "sample string 2",
            "outletCode": "sample string 3",
            "orderCode": "sample string 4",
            "outletName": "sample string 5",
            "propertyCode": "sample string 6",
            "roomNumber": "sample string 7",
            "guestFirstName": "sample string 8",
            "guestLastName": "sample string 9",
            "guestLanguageCode": "sample string 10",
            "conversationStatus": "sample string 11",
            "conversationType": "sample string 12",
            "messages": [
              {
                "createDate": "2024-12-04T08:22:43.0733787+00:00",
                "code": "sample string 2",
                "isRead": true,
                "serviceCenterName": "sample string 4",
                "messageType": "sample string 5",
                "content": "sample string 6",
                "firstName": "sample string 7",
                "lastName": "sample string 8",
                "languageCode": "sample string 9",
                "isTranslated": true,
                "conversationId": 11
              },
              {
                "createDate": "2024-12-04T08:22:43.0733787+00:00",
                "code": "sample string 2",
                "isRead": true,
                "serviceCenterName": "sample string 4",
                "messageType": "sample string 5",
                "content": "sample string 6",
                "firstName": "sample string 7",
                "lastName": "sample string 8",
                "languageCode": "sample string 9",
                "isTranslated": true,
                "conversationId": 11
              }
            ]
          }
        },
        "succeeded": true
      }
    }
  ],
  "status": "Success"
}