Uma visão geral da API Get Users da Interakt (API de recuperação de contatos)
Coleção Postman para esta API.
Sempre que você receber um novo lead no WhatsApp via Interakt, agora você pode garantir que os detalhes desse lead sejam repassados para seus outros CRMs/bancos de dados usando a API de recuperação de contatos. Basta adicionar as chamadas de API ao código do seu sistema ou usar essas chamadas de API em plataformas de conector (como Integromat/Zapier) para sincronizar o Interakt com seus CRMs baseados em SaaS.
Autenticação: A autenticação usos do mecanismo Autenticação básica HTTP que exige que você envie sua chave de API precedida do 'Básico' corda. Este valor é passado no cabeçalho em 'Autorização' e o par de chaves do cabeçalho será semelhante a 'Autorização: BásicoChave API>'.
Observe: Você pode encontrar o Chave API em seu painel. Vá para Configurações > Configuração do desenvolvedor > Chave secreta.
Parâmetros de consulta: Existem 2 parâmetros de consulta que podem ser incluídos na URL na qual a API será chamada: https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
Limite: O valor padrão é 100. Se a resposta da API contiver mais de 100 contatos, o campo 'has_next_page' na resposta da API será verdadeiro e a API deverá ser chamada novamente, mantendo o deslocamento como 100.
Compensar: O valor padrão é 0.
Erros: Nosso endpoint de API retornará um código de status 200 para todas as solicitações bem-sucedidas. Erros 4xx serão mostrados nos seguintes casos:
. Se as credenciais de autorização foram inseridas incorretamente.
. Se o parâmetro de consulta 'limit' tiver sido definido como > 100
. Se 'val' de 'created_at_utc' ou 'modified_at_utc' não estiver no formato UTC na carga útil da API
. Se as propriedades 'op' ou 'supr_op' não foram inseridas corretamente
Erros 5xx serão mostrados no caso de alguns erros internos.
Como chamar Get API no Interakt
Para recuperar contatos que foram criados no Interakt após as 5h (IST) do dia 8 de setembro de 2021, a seguinte carga útil pode ser enviada na chamada de API.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
{
“filtros”: [
{
“traço”: “criado_em_utc”,
“op”: “gt”,
“val”: “2021-09-08T11:30:00.000Z”
}
]
}
Para recuperar contatos que foram criados no Interakt antes das 5h (IST) do dia 8 de setembro de 2021, a seguinte carga útil pode ser enviada na chamada de API.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
{
“filtros”: [
{
“traço”: “criado_em_utc”,
“op”: “lt”,
“val”: “2021-09-08T11:30:00.000Z”
}
]
}
Para recuperar contatos que foram criados no Interakt após as 5h (IST) do dia 7 de setembro de 2021 e antes das 5h (IST) do dia 8 de setembro de 2021, a seguinte carga útil pode ser enviada na chamada de API.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
{
“filtros”: [
{
“traço”: “criado_em_utc”,
“op”: “gt”,
“val”: “2021-09-07T11:30:00.0000”
},
{
“traço”: “criado_em_utc”,
“op”: “lt”,
“supr_op”: “e”,
“val”: “2021-09-08T11:30:00.0000”
}
]
}
Para recuperar contatos que foram modificada no Interakt após as 5h (IST) do dia 8 de setembro de 2021, a seguinte carga útil pode ser enviada na chamada de API.
POST https://api.interakt.ai/v1/public/apis/users/?offset=0&limit=100
{
“filtros”: [
{
“traço”: “modificado_at_utc”,
“op”: “gt”,
“val”: “2021-09-08T11:30:00.000Z”
}
]
}
Observação: Sempre envie o valor da data e hora no formato UTC. Caso tenha sido enviada apenas a data sem hora (exemplo: 2021/09/08), o horário será assumido como 00:00 horas.
