live-chat

POST `/v1/chat/conversations/{conversationId}/messages`

An operator answers a visitor.

Autenticação

Envie uma chave de API como um token de portador. A chave deve ter a permissão livechat.reply; uma chave sem ela é recusada com 403, e não 404.

Este endpoint não requer um ID de organização. Sua chave já identifica a organização à qual pertence, e a resposta é delimitada a ela.

Experimente

Substitua qualquer item entre colchetes por seus próprios valores e o espaço reservado para a chave por uma chave do seu painel.

curl -X POST https://api.zinndigital.com/v1/chat/conversations/{conversationId}/messages \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "message": <string> }'

Conectado? O console da API no seu painel preenche o ID da sua organização real e a sua própria chave, e executa a requisição contra a API de produção para que você possa ver a resposta real. Abra este endpoint no console da API

Detalhes

Requires `livechat.reply`. Claims the conversation for the caller if nobody has it yet, so the assistant stops answering over the top of a person.

Parâmetros

Nome	Tipo	Obrigatório	O que é
`conversationId (path)`	`string`	Sim	—

Corpo da requisição

Nome	Tipo	Obrigatório	O que é
`message`	`string`	Sim	—

Resposta

Nome	Tipo	Obrigatório	O que é
`id`	`string`	Sim	—
`widget_id`	`string`	Sim	—
`state`	`string<ai, waiting, open, offline, closed>`	Sim	—
`visitor_name`	`string`	Sim	—
`visitor_email`	`string`	Sim	—
`page_url`	`string`	Sim	—
`page_title`	`string`	Sim	—
`referrer`	`string`	Sim	—
`country`	`string`	Sim	Two-letter country, resolved at our edge from the connection. The visitor's IP address itself is never stored.
`locale`	`string`	Sim	—
`assigned_operator`	`string`	Sim	—
`cursor`	`integer`	Sim	—
`started_at`	`string`	Sim	—
`last_message_at`	`string`	Sim	—
`message`	`ChatMessage`	Não	—

Erros que este endpoint pode retornar

401 · 403 · 404 · 422

POST /v1/chat/conversations/{conversationId}/messages