contato/lista-contato
DESCRIÇÃO | Este método retorna os contatos cadastrados de acordo com os filtros de busca |
ESTRUTURA DA URL | |
VERSÃO | 1 |
MÉTODO | POST |
PARÂMETROS | format opcional Opção de retorno da API podendo ser JSON ou XML, se não informado JSON será o padrão acess_token obrigatório Chave de acesso ao método, para saber como obter /wiki/spaces/AppZendesk/pages/950291 pagina opcional Opção para paginação da lista de contatos. Valor numérico inteiro id_contato opcional Código do contato. Valor numérico inteiro id_grupo opcional Código do Grupo de Contato. Valor numérico inteiro razao_social opcional Filtro com Nome Razão Social da Empresa contato opcional Filtro com Nome do Contato telefone_fixo opcional Filtro com o numero de telefone celular opcional Filtro com o numero de celular email opcional Filtro com e-mail do contato pagina opcional Lista uma pagina especifica |
RETORNO | api Origem API que está sendo usada modulo Módulo que está sendo chamado status Mensagem de status codigo Código de retorno -Clique aqui para listar os códigos e suas descrições data Array de resposta da API pagina_atual Quantidade de páginas itens_por_pagina Total máximo de item por página total_de_paginas Quantidades de páginas geradas total_pagina_atual Total de item dá pagina solicitada, se não for solicitado vai informar o total de item da ultima página Exemplo de respostas em JSON { "api": "contato", "modulo": "contato", "status": "ok", "codigo": "000", "data": [ { "id_contato": "XX", "id_empresa": "XXXX", "empresa_nome": "NOME EMPRESA", "id_usuario": "XXXX", "id_grupo": "XX", "grupo_nome": "Fornecedores", "razao_social": "NOME EMPRESA DO CONTATO LTDA", "contato": "NOME DO CONTATO", "telefone_fixo": "5541XXXXXXXX", "celular": "", "email": "fornecedor@email.com.br", "pais": "", "cep": "", "rua": "", "numero": "0", "bairro": "", "complemento": null, "cidade": "", "estado": null, "ramo_atividade": "", "observacao": "", "oauth_id_responsavel": null } ], "pagina_atual": 1, "itens_por_pagina": 100, "total_de_paginas": 1, "total_pagina_atual": 1 } Validade dos tokens: Os tokens de acesso têm uma validade limitada, por isso convém que o sistema criado tenha em conta estes timings para que possa desenvolver rotinas de requisação de novos tokens. |