|
|
Integração de consulta de contato por telefone Versão 1.0
Introdução
Esta API retorna a consulta do usuário e contato do CRM Zen.
Obs.: Para integração de contato, notas e calendário usar nossa API padrão. Clique aqui para ver a documentação
Requisições
A url e o token são gerados na área de Integração do Zen (No topo do CRM Zen, clique no ícone de engrenagem e depois selecione Integração).
Todas as requisições devem conter o parâmetro token (na querystring).
Os dados são uma string JSON válida, no seguinte modelo:
{
"Email" : "usuariozen@email.com",
"Telefone" : "+5511988887777"
}
Obs.: O JSON deve ser encodado em UTF-8
Obs.: O token NÃO deve ser divulgado publicamente em hipótese alguma
Respostas
Todas as respostas estarão no formato JSON.
Respostas bem sucedidas serão da seguinte forma:
"Contatos": [ {"Nome" : "wSoMa" , "Email" : "atendimento@wsoma.com", "Codigo":"ZEND8360D8"},
{"Nome" : "wSoMa2", "Email" : "atendimento@wsoma.com", "Codigo":"ZEN02F60B0"},
{"Nome" : "wSoMa3", "Email" : "atendimento@wsoma.com", "Codigo":"ZEN092C73B"},
{"Nome" : "wSoMa4", "Email" : "atendimento@wsoma.com", "Codigo":"ZENC77BDA4"}]
Erros
Obs.: Caso ocorra alguma falha na requisição mantenha uma fila e tente novamente.
Na ocorrência de erros, a resposta será da seguinte forma:
{
"Erro" : "Código",
"Mensagem" : "Descrição do erro"
}
Mensagens de retorno
400 Bad Request
| Descrição do Erro |
| Email obrigatório |
| Usuário não cadastrado |
| Telefone obrigatório |
| Contato não encontrado |
| Json obrigatório |
| Erro na estrutura do JSON, JSON Inválido |
| Json Incompleto |
401 Unauthorized
| Descrição do Erro |
| Token obrigatório. |
| Token inválido. |
| Limite de 120 requisições por minuto excedido. Tente novamente. |
500 Internal Server Error
| Descrição do Erro |
| Ocorreu um erro interno no servidor. Tente novamente. |
Parâmetros
| Parâmetro |
Tipo |
Tamanho |
Descrição |
| Email |
String |
100 |
Email de usuário no CRM Zen (Obrigatório) |
| Telefone |
String |
33 |
Telefone do contato (Obrigatório) |
|