Ticket API

Endpoint to converse with a ticket automation virtual agent.

Server Address: https://api.ultimate.ai

Request

post/converse/ticket

Headers Parameters:

AuthorizationstringRequired
String API Key for the bot. The key can be generated on custom CRM integration page in our Ultimate.ai Dashboard. Please see Authentication article to learn more.
botidstringRequired
The ID of the bot that is sending the event.

Body

Required

Request Body Schema: application/json

platformConversationIdstring
An ID provided by the custom CRM to identify the conversation. The custom CRM application can decide the format.
textstring
String content of email
platformstring
Name of the used platform. For a custom CRM application, this should be "PUBLIC_API".
metadataarray
Variables to store in session
1. keystring
  Variable key/name
2. valuestring
  Variable value
3. sanitizeboolean
  Variable sanitize flag

Response

The request has been acknowledge and will be processed. The actual response will come through webhooks.

ENDPOINT: https://api.ultimate.ai/converse/ticket

Request Example:

{
  "platformConversationId": "string",
  "text": "string",
  "platform": "string",
  "metadata": [
    {
      "key": "string",
      "value": "string",
      "sanitize": true
    }
  ]
}