Documentacao da API IAra
🔌

Client API e canais proprios

2 artigos Suporte Por Suporte

Criar experiencias proprias de chat com inbox_identifier, contatos publicos, conversas publicas e mensagens.

Client API: criar contato, conversa e mensagem

Client API: criar contato, conversa e mensagem Use Client API quando seu site ou aplicativo precisa criar uma experiencia propria de chat em uma caixa de API ja configurada pela IAra. Criar contato publico export INBOX_IDENTIFIER="seu_inbox_identifier" curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts" \ -H "Content-Type: application/json" \ -d '{ "identifier":"cliente-123", "name":"Maria Cliente", "email":"[email protected]", "phone_number":"+5554999999999" }' Criar conversa export CONTACT_IDENTIFIER="cliente-123" curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations" \ -H "Content-Type: application/json" \ -d '{"custom_attributes":{"origem":"app_digi2b"}}' Enviar mensagem curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations/$CONVERSATION_ID/messages" \ -H "Content-Type: application/json" \ -d '{"content":"Ola, preciso de ajuda com minha integracao IAra."}' Identidade validada Se a caixa exigir validacao, gere identifier_hash no seu backend. Nao exponha segredo da caixa no frontend.

Client API: status, typing, last seen e historico

Client API: status, typing, last seen e historico Depois que a conversa existe, a Client API permite consultar historico e atualizar estados visiveis na experiencia do contato. Listar conversas e mensagens curl -X GET "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations" curl -X GET "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations/$CONVERSATION_ID/messages" Resolver conversa curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations/$CONVERSATION_ID/toggle_status" \ -H "Content-Type: application/json" \ -d '{"status":"resolved"}' Typing e last seen curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations/$CONVERSATION_ID/toggle_typing" \ -H "Content-Type: application/json" \ -d '{"typing_status":"on"}' curl -X POST "$BASE_URL/public/api/v1/inboxes/$INBOX_IDENTIFIER/contacts/$CONTACT_IDENTIFIER/conversations/$CONVERSATION_ID/update_last_seen" Cuidados Client API e para experiencia do contato. Para relatorios, administracao e automacoes internas, use Application API em backend seguro.