ALTU
Search…
Atendimentos

Objetivo

A API de atendimentos (Contacts) tem por objetivo consultar os atendimentos de uma determinada instância do Altu.

Request

post
https://api.altubots.com/contacts/<instancia>
Body template
1
{
2
"filters": {
3
"id": "ID do atendimento",
4
"assistantId": "ID do assistente",
5
"identifier": "Identifier do contato",
6
"externalId": "External id do atendimento",
7
"startDate": "Início do período da consulta (Y-m-d)",
8
"endDate": "Fim do período da consulta (Y-m-d)",
9
"source": "Canal de origem do atendimento",
10
"limit": "Quantidade de resultados por página" //Default: 100 - max: 500
11
}
12
"attributes": {
13
"cpf": "CPF do atendimento",
14
"phone": "Telefone do atendimento",
15
"email": "Email do atendimento",
16
"identification_number": "Extra de identificação",
17
"identification_number2": "Extra de identificação 2",
18
"identification_number3": "Extra de identificação 3",
19
"identification_number4": "Extra de identificação 4"
20
},
21
"flags": {
22
"history": "Boolean para trazer ou não o histórico de mensagens do atendimento", //Default: false
23
"events": "Boolean para trazer ou não o histórico de eventos do atendimento" //Default: false
24
},
25
"pagination": "Hash para consultar a próxima página"
26
}
Copied!

Limitações

  • Máximo de resultados por consulta: 500
    • Utilizar paginação para buscar páginas seguintes
  • Consultas que não tenham o filter id, identifier ou phone não retornarão histórico e eventos
  • Um fluxo comum de requisições/consultas seria:
    1. 1.
      Consultar pelo assistantId, startDate e endDate
    2. 2.
      Em cada atendimento encontrado, usar o id ou identifier para fazer uma nova consulta com a flag history: true para buscar o histórico daquele atendimento
  • Limite de 50000 consultas por dia e 10 por segundo
O paginationé disponibilizado no response da primeira consulta para que você possa referenciá-lo no body da próxima consulta e assim sucessivamente.
Last modified 7mo ago