Complete reference

/conversations

Create a new conversation.

Request parameters

{
  "session": "bc29c839-46bb-42e0-b239-f98496bda100",
  "bot_id": "1035",
  "channel_type": "Web",
  "locale": "en-US",
  "customer_details": {
    "external_id": "bc29c839-46bb-42e0-b239-f98496bda100",
    "email": "john@gmail.com",
    "phone_number": "+40752875392",
    "name": "John Doe",
    "additional_properties": {}
  }
}

Responses

/conversations/{sessionId}

Gets an existing conversation by the session id used to create it.

Request parameters

Responses

/messages

Sends a new message to the conversation.

Request parameters

{
  "type": "pwt",
  "session": "bc29c839-46bb-42e0-b239-f98496bda100",
  "id": "a01fe2b2-3125-4ec7-9c0b-fee54c219e73",
  "timestamp": "2023-10-12T07:20:50.52Z",
  "text": "Your estimated wait time is 2 minutes.",
  "author": "agent",
  "author_name": "Jane Smith",
  "channel_type": "Web",
  "data": {
    "Predicted Wait Time": {
      "pwt": 37
    }
  }
}

Responses

Last modified: 15 March 2024