Conversas e mensagens
.png?v=1790870524 "Suporte")
Por Suporte
Por Suporte
Listar, criar, atribuir, atualizar, etiquetar, priorizar conversas e enviar mensagens pela conta.
Conversas: listar, criar, filtrar e atualizar
Conversas: listar, criar, filtrar e atualizar Conversas organizam o atendimento entre contato, caixa de entrada, mensagens, agente, time, etiquetas, status e atributos. Listar conversas curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations" \ -H "api_access_token: $API_TOKEN" Criar conversa Criar conversa exige source_id. curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "source_id": "crm-ticket-987", "inbox_id": 102, "contact_id": 123, "status": "open", "message": {"content":"Recebemos sua solicitacao pela IAra."} }' Filtrar conversas Use /conversations/filter para filtros estruturados, e /conversations/meta para contagens como abertas, nao atribuidas e totais. Atualizar conversa Use o endpoint de atualizacao para alterar atributos permitidos. Use endpoints especificos para status, prioridade, labels e atribuicao quando existirem. Boas praticas Guarde o conversation_id no sistema externo. Nao crie nova conversa se o mesmo assunto ainda esta em andamento.
Conversas: atribuicao, status, prioridade, labels e atributos
Conversas: atribuicao, status, prioridade, labels e atributos Use endpoints especificos para organizar a fila de atendimento. Atribuicao curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/assignments" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"assignee_id":35, "team_id":5}' Status Status comuns: open, pending, resolved e snoozed. curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/toggle_status" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"status":"pending"}' Prioridade curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/toggle_priority" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"priority":"high"}' Labels curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/labels" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"labels":["suporte", "api"]}' Atributos personalizados curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/custom_attributes" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"custom_attributes":{"protocolo":"DG-2026-0001"}}'
Mensagens, anexos e eventos da conversa
Mensagens, anexos e eventos da conversa A API de mensagens permite listar, criar e, quando permitido, excluir mensagens de uma conversa. Listar mensagens curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/messages" \ -H "api_access_token: $API_TOKEN" Criar mensagem curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/messages" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "content": "Ola, Maria. Segue retorno do suporte IAra.", "message_type": "outgoing", "private": false }' Nota interna { "content": "Contexto interno para o time.", "message_type": "outgoing", "private": true } Anexos Quando o endpoint aceitar arquivo, use multipart/form-data. curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/messages" \ -H "api_access_token: $API_TOKEN" \ -F "content=Segue anexo" \ -F "message_type=outgoing" \ -F "attachments[]=@/caminho/arquivo.pdf" Reporting events Use /conversations/:conversation_id/reporting_events para eventos de metricas da conversa, como primeira resposta e resolucao, quando disponivel para o usuario.