POST API/V40/Interactive/Messages/NonVerifiedGuestConversations

Create non verified guest conversation

Request Information

URI Parameters

None.

Body Parameters

The request model

CreateNonVerifiedGuestConversationRequest

Name	Description	Type	Additional 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
OrderFormDetailsDictionary	Dictionary to contain Order Form Details for the outlet, setup in GXP Manager.	Dictionary of string [key] and Object [value]
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",
  "orderFormDetailsDictionary": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "sessionToken": "sample string 5"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseContainerModel

Name	Description	Type
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 CreateConversationResponse
Status	The success status the composite message.	CompositeStatus

Response Formats

application/json, text/json

Sample:

{
  "sessionToken": "Hstvtz7-3IgKAAAAAAAAAAAAAAA.meXDp73DKl2oRqGW-HKZn1Y3TENcEyJRb7K-StaaUvQ",
  "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-11-06T08:40:49.8752286+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-11-06T08:40:49.8752286+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"
}