Skip to main content
GET
Listar conversas

Authorizations

Authorization
string
header
required

Chave de API no cabeçalho Authorization: Bearer SUA-CHAVE.

A API também aceita x-api-key: SUA-CHAVE e Authorization: ApiKey SUA-CHAVE — as três formas são equivalentes, inclusive para o limite de requisições.

A chave dá acesso total à conta e é de servidor para servidor: não a use em navegador ou aplicativo móvel.

Query Parameters

channel
string

whatsapp, telegram, webchat.

channel_id
string

Conta de canal, vinda de GET /v1/channels.

status
enum<string>
default:open
Available options:
open,
resolved,
archived,
all
assigned
boolean

Com ou sem atendente responsável.

since
string<date-time>
until
string<date-time>
channel_identifier
string

Endereço nativo do contato no canal.

phone
string

Telefone. Ambíguo por construção — ver acima.

limit
integer
default:25
Required range: x <= 100
cursor
string

next_cursor da página anterior.

Response

Página de conversas.

success
boolean
data
object
timestamp
string<date-time>