v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Create new chat

This method allows you to create a chat before sending the first message.

post/{scope_id}/chats

Path parameters

scope_idstring required

You got the scope_id as a part of response in Step 2

Headers

Datestring required

Date and time when the request was generated. The signature will be valid for 15 minutes from this Date. The date should be in the format “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822)

Content-type'application/json' required

Request data type. Currently, only application/json is supported.

Content-MD5string required

For the request body

X-Signaturestring required

Signature of the request as a string.

Request body

conversation_idstring required

Chat ID on the integration side (your integration should generate it, it can be a phone number, a username)

profile_linkstring

Url to the chat participant profile

Response

200

idstring

Example response

{
  "id": "XXXXXXX-10e9-4f88-af0b-6581795e15e2",
  "user": {
    "id": "XXXXXXX-7bd3-4934-b05f-23f1db1a6514",
    "client_id": "XXXXXXX-86df-4c49-a0c3-a4816df41af0",
    "name": "Client",
    "avatar": "https://www.example.com/users/avatar.png",
    "phone": "+1234567890",
    "email": "client409@example.com"
  }
}