Documentacao da API IAra
⚙️

Organizacao da conta

3 artigos Suporte Por Suporte

Recursos de conta como agentes, times, caixas, etiquetas, respostas prontas, atributos e filtros personalizados.

Agentes, times, perfil e dados da conta

Agentes, times, perfil e dados da conta Use estes endpoints para consultar e manter a organizacao operacional da conta conforme as permissoes do usuario autenticado. Perfil do usuario autenticado curl -X GET "$BASE_URL/api/v1/profile" \ -H "api_access_token: $API_TOKEN" Conta atual curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID" \ -H "api_access_token: $API_TOKEN" Agentes curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/agents" \ -H "api_access_token: $API_TOKEN" Times curl -X GET "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/teams" \ -H "api_access_token: $API_TOKEN" Membros de time Use /teams/:team_id/team_members para listar, adicionar ou atualizar membros quando o usuario tiver permissao administrativa. Cuidados Alteracoes em agentes e times afetam roteamento de conversas. Para integracoes, prefira consultar IDs e usar atribuicao de conversa, em vez de mudar a estrutura da equipe sem processo interno.

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.

Etiquetas, 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.