v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Etapa 3: Criar novo chat

Este método permite criar um chat antes de enviar a primeira mensagem.

post/{scope_id}/chats

Path parameters

scope_idstring required

Você obteve o scope_id como parte da resposta no Etapa 2.

Headers

Datestring required

Data e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. A data deve estar no formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822).

Content-type'application/json'

Tipo de dado da solicitação. Atualmente, apenas application/json é suportado.

Content-MD5string

Para o corpo da solicitação.

X-Signaturestring

Assinatura da solicitação como uma string.

Request body

conversation_idstring required

ID do chat no lado da integração (sua integração deve gerá-lo, pode ser um número de telefone ou um nome de usuário).

profile_linkstring

URL para o perfil do participante do chat.

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"
  }
}