Menu

Conceitos

Migrando do Chatwoot

Equivalências de conceitos e endpoints para quem já integra com o Chatwoot.

Se você já integra com o Chatwoot, a API da ConverZAP vai parecer familiar: os conceitos de conversa, mensagem, nota, etiqueta, atendente, equipe e resposta pronta são os mesmos. As diferenças principais:

Conceitos

ChatwootConverZAP
/api/v1/accounts/{account_id}/.../v1/... (a conta vem da chave)
api_access_token (token de usuário, sem escopo)Authorization: Bearer czk_live_… com escopos
inboxcanal = número de WhatsApp (/v1/channels, id = phone_number_id)
várias conversas por contatouma conversa por contato e número
status open / pending / snoozed / resolvedopen / snoozed / resolved; o "pending" do bot vira awaiting_human: true
message_type 0/1/2direction: inbound / outbound + author (contact, user, ai_agent, phone, campaign…)
private: truenotas em /conversations/{id}/notes
datas em UnixISO 8601 em tudo
page com tamanhos fixoscursor (limit, cursor)
erros variadosRFC 9457 com code estável

Endpoints equivalentes (leitura)

ChatwootConverZAP
GET /conversations?status=&assignee_type=&inbox_id=&labels[]=GET /v1/conversations?status=&assignee=&channel=&label= (assignee: me, unassigned, assigned ou id)
GET /conversations/metaGET /v1/conversations/counts
GET /conversations/{id}/messagesGET /v1/conversations/{id}/messages
GET /contacts · /contacts/searchGET /v1/contacts?q= · GET /v1/contacts/by-phone/{phone}
GET /labelsGET /v1/labels
GET /custom_attribute_definitionsGET /v1/custom-fields (só de contato)
GET /agents · /teams · /inboxesGET /v1/users · /v1/teams · /v1/channels
GET /canned_responsesGET /v1/canned-responses
GET /inboxes/{id}/message_templatesGET /v1/templates
GET /api/v2/reports/summaryGET /v1/reports/inbox (com o período anterior)

O que não existe aqui

Prioridade de conversa, atributos personalizados de conversa (use os campos do contato), equipe atribuída à conversa (na ConverZAP a equipe se liga aos números e ao rodízio), indicador de digitação e contact_inboxes (o telefone E.164 basta).

Envio de mensagens, notas e ações da conversa chegam na próxima fase (escrita).