Documentacao da API IAra
Pesquise aqui os artigos ou procure as categorias abaixo.
Browse by topic
Find guides, tutorials, and answers organised by category.
Escopo e primeiros passos
O que o cliente pode usar na API IAra, limites de escopo, base URL, autenticacao e padroes de resposta.
.png?v=1790863815 "Suporte")
Browse
Contatos e identificadores
Criar, buscar, atualizar, filtrar, mesclar contatos e vincular contatos a caixas de entrada.
Browse
Conversas e mensagens
Listar, criar, atribuir, atualizar, etiquetar, priorizar conversas e enviar mensagens pela conta.
Browse
Client API e canais proprios
Criar experiencias proprias de chat com inbox_identifier, contatos publicos, conversas publicas e mensagens.
Browse
Organizacao da conta
Recursos de conta como agentes, times, caixas, etiquetas, respostas prontas, atributos e filtros personalizados.
Browse
Automacoes e webhooks
Webhooks, regras de automacao e hooks de integracao disponiveis no escopo da conta.
Browse
Relatorios e auditoria
Metricas de conta, agentes, times, canais, eventos de conversa, CSAT e auditoria quando habilitada.
Browse
Central de ajuda via API
Gerenciar portais, categorias e artigos da central no escopo da conta.
Browse
Erros e boas praticas
Erros HTTP, paginacao, idempotencia, uso seguro de tokens e checklist de suporte para integracoes.
Browse
Popular articles
What other people are reading right now.
Caixas de entrada e canais
Caixas de entrada e canais Caixas de entrada representam os canais da conta, como WhatsApp, chat do site, e-mail, Instagram, Facebook ou API. Listar caixas curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/inboxes" \ -H "api_access_token: $API_TOKEN" Obter caixa curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/inboxes/102" \ -H "api_access_token: $API_TOKEN" Agentes da caixa curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/inbox_members/102" \ -H "api_access_token: $API_TOKEN" Criacao e configuracao de canais Alguns endpoints oficiais permitem criar ou atualizar inboxes, mas na IAra certos canais e provedores sao provisionados pela Digi2B. Isso inclui WhatsApp, provedores internos e configuracoes que dependem de credenciais externas. Regra pratica Use a API para consultar caixas, descobrir IDs e automatizar conversas. Para criar ou alterar canais sensiveis, acione a Digi2B.
📊 Relatorios e auditoriaRelatorios da conta e metricas de atendimento
Relatorios da conta e metricas de atendimento A API de relatorios permite consumir indicadores da operacao de atendimento quando o usuario autenticado tem permissao. Rotas principais | Recurso | Rota | | --- | --- | | Relatorios gerais | /api/v2/accounts/:account_id/reports | | Sumario | /api/v2/accounts/:account_id/reports/summary | | Conversas | /api/v2/accounts/:account_id/reports/conversations | | Eventos de reporting | /api/v1/accounts/:account_id/reporting_events | | Sumario por agente | /api/v2/accounts/:account_id/summary_reports/agent | | Sumario por time | /api/v2/accounts/:account_id/summary_reports/team | | Sumario por inbox | /api/v2/accounts/:account_id/summary_reports/inbox | | Sumario por canal | /api/v2/accounts/:account_id/summary_reports/channel | Exemplo curl -X GET "$BASE_URL/api/v2/accounts/$ACCOUNT_ID/reports?type=account&metric=conversations_count" \ -H "api_access_token: $API_TOKEN" Relatorios complementares A documentacao oficial tambem traz relatorios como distribuicao de primeira resposta por canal, matriz inbox-label e mensagens enviadas agrupadas por agente, time, inbox ou etiqueta. Boas praticas Extraia em janelas de data, consolide em banco proprio para BI e evite chamar relatorios pesados em toda abertura de dashboard.
📊 Relatorios e auditoriaCSAT, audit logs e eventos de conversa
CSAT, audit logs e eventos de conversa Alguns endpoints dependem de permissao, plano ou recurso habilitado na conta. CSAT survey page A rota de CSAT permite redirecionar o cliente para uma pagina de avaliacao quando a operacao usa pesquisa de satisfacao. Reporting events da conversa Use eventos de conversa para entender marcos como primeira resposta, resolucao e outros tempos operacionais. curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/conversations/456/reporting_events" \ -H "api_access_token: $API_TOKEN" Audit logs Audit logs aparecem na API oficial como recurso de conta, mas podem depender de edicao/plano e permissao administrativa. Use apenas quando a Digi2B confirmar que a conta possui o recurso habilitado. curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/audit_logs" \ -H "api_access_token: $API_TOKEN" Cuidados Eventos e logs podem conter informacao operacional sensivel. Use somente para auditoria, BI autorizado e acompanhamento de qualidade.
⚙️ Organizacao da contaEtiquetas, respostas prontas, atributos e filtros
Etiquetas, respostas prontas, atributos e filtros Esses recursos ajudam a organizar atendimento e padronizar operacoes dentro da conta. Etiquetas da conta curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/labels" \ -H "api_access_token: $API_TOKEN" Use labels para classificar conversas e contatos. Respostas prontas curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/canned_responses" \ -H "api_access_token: $API_TOKEN" Respostas prontas podem ser criadas, atualizadas ou removidas por usuarios com permissao. Atributos personalizados curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/custom_attribute_definitions" \ -H "api_access_token: $API_TOKEN" Use atributos para contexto de contato e conversa, como id_crm, plano, unidade ou origem. Filtros personalizados curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/custom_filters?filter_type=conversation" \ -H "api_access_token: $API_TOKEN" Governanca Padronize nomes antes de integrar. Evite duplicar campos com grafias diferentes, como plano, Plano e tipo_plano.
⚡ Automacoes e webhooksWebhooks, automacoes e integration hooks
Webhooks, automacoes e integration hooks Use webhooks para enviar eventos da IAra a sistemas externos. Use regras de automacao e hooks de integracao quando estiverem habilitados para a conta. Webhooks curl -X POST "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/webhooks" \ -H "api_access_token: $API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "name":"CRM Digi2B", "url":"https://integracoes.digi2b.com/webhooks/iara", "subscriptions":["conversation_created", "message_created", "contact_updated"] }' Eventos comuns incluem conversation_created, conversation_status_changed, conversation_updated, message_created, message_updated, contact_created, contact_updated, webwidget_triggered, conversation_typing_on e conversation_typing_off. Automation rules Rotas de /automation_rules permitem listar, criar, atualizar e remover regras quando o usuario tiver permissao. Integration hooks Rotas de /integrations/apps e /integrations/hooks servem para integracoes suportadas na conta. Cuidados O endpoint receptor do webhook deve responder rapido com status 2xx. Para processamento pesado, coloque o evento em fila e responda antes.
💬 Conversas e mensagensConversas: 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.