ZaplinDocs
GuiasReferência da APIMCPChangelogAbrir o app

Iniciar conversa

POST
/v1/conversations

Abre a conversa com um contato (contact_id) ou um telefone em um número (number_id de list_numbers), criando-a quando não existe; depois send_message escreve nela.

Escopo: messages:write

Autorização

bearer messages:write
headerAutorizaçãoBearer <token>

A chave de API de uma conta de serviço (sk_live_…, 600 requisições por minuto cada) ou um access token OAuth para o recurso /api/v1 (600 requisições por minuto por conexão).

Escopo: messages:write

Cabeçalhos

Idempotency-Key?string

Até 200 letras, dígitos, - ou _. A primeira resposta a uma chave é repetida por 24 horas.

Tamanholength <= 200

Corpo da requisição

application/json
  1. body
number_id*string
Tamanho1 <= length <= 100
contact_id?string
Tamanho1 <= length <= 100
phone?string
Tamanholength <= 40

Corpo da resposta

Feito.

application/json
  1. response
id*string
Exemplo de requisição
curl -X POST 'https://app.zaplin.com.br/api/v1/conversations' \  -H 'Authorization: Bearer sk_live_...' \  -H 'Content-Type: application/json' \  -d '{  "number_id": "string"}'
Exemplo de resposta
{  "id": "string"}