Pesquisar Assuntos do CRM API 2.0
Serviço destinado a fazer consulta de assuntos.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
formato | string | obrigatório | Formato do retorno (json) |
pesquisa (1) | string | opcional | Campo de pesquisa (busca por nome do cliente,assunto ou ação) |
estagioCliente (1) (2) | string | opcional | Estágio do cliente no CRM |
estagioAssunto (1) (3) | string | opcional | Estágio do assunto no CRM |
situacaoAssunto (1) (4) | string | opcional | Situação do assunto no CRM |
filtroPor (1) (5) | string | opcional | Opção de filtro por período |
dataInicial (1) (6) | string | opcional | Data incial dos assuntos que deseja consultar no formato dd/mm/yyyy |
dataFinal (1) (6) | string | opcional | Data final dos assuntos que deseja consultar no formato dd/mm/yyyy |
idVendedor (1) (3) | string | opcional | Número de identificação do vendedor no Tiny |
nomeVendedor (1) (3) (4) | string | opcional | Nome do vendedor no Tiny |
pagina (5) | int | opcional | Número da página |
(1) - Ao menos um desses parâmetros deve ser informado.
(2) - Código da estágio do cliente, conforme tabela de Estágios do cliente.
(3) - Código da estágio do assunto, conforme configuração da conta Tiny, estes código podem ser obtidos através da Lista de estágios de assuntos do CRM.
(4) - Código da situação do assunto, conforme tabela de Situções do Assunto.
(5) - Código do filtro por período, conforme tabela de: Opções de filtro por período.
(6) - Esta opçõa somente será considerada caso o parâmetro filtroPor contenha os valores ("C" ou "P").
(7) - Caso o vendedor não seja localizado no Tiny a consulta não retornará registros.
(8) - Este valor será desconsiderado caso seja informado valor para o parâmetro idVendedor.
(9) - Numero da página que deseja obter (por padrão são listados 100 registros por página), caso não seja informado o valor padrão é 1.
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | object- | object | obrigatório | Elemento raiz do retorno |
retorno.status_processamento | int | - | obrigatório | Conforme tabela "Status de Processamento" |
retorno.status | string | - | obrigatório | Contém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
retorno.codigo_erro (1) | int | - | condicional | Conforme tabela "Códigos de erro" |
retorno.erros.[ ] (1) (3) | list | - | condicional [0..n] | Contém a lista dos erros encontrados. |
retorno.erros.[ ]erro | string | - | condicional | Mensagem contendo a descrição do erro |
retorno.pagina | int | - | obrigatório | Número da página que está sendo retornada |
retorno.numero_paginas | int | - | obrigatório | Número de paginas do retorno |
retorno.assuntos[ ] (2) | list | - | condicional | Lista de resultados da pesquisa |
retorno.assuntos[ ].assunto (2) | object | - | condicional | Elemento utilizado para representar um assunto. |
retorno.assuntos[ ].assunto.id | int | - | condicional | Número de identificação do assunto no Tiny |
retorno.assuntos[ ].assunto.cliente | string | 50 | condicional | Nome do cliente |
retorno.assuntos[ ].assunto.estagio_cliente (4) | string | 50 | condicional | Estágio do cliente no CRM |
retorno.assuntos[ ].assunto.texto_assunto | string | - | condicional | Texto do assunto do Crm |
retorno.assuntos[ ].assunto.proxima_acao | string | - | condicional | Próxima ação do assunto no Crm |
retorno.assuntos[ ].assunto.tipo_data_acao(5) | string | 1 | condicional | Tipo de data da ação |
retorno.assuntos[ ].assunto.data_acao(6) | date | 20 | condicional | Data da ação |
retorno.assuntos[ ].assunto.estagio_assunto(7) | string | 1 | condicional | Estágio do assunto no CRM |
retorno.assuntos[ ].assunto.situacao_assunto(8) | string | 1 | condicional | Situação do assunto no CRM |
(1) - Somente estará presente no retorno caso o elemento "status" seja "Erro".
(2) - Somente estará presente no retorno caso o elemento "status" seja "OK".
(3) - Estes campos somente serão informados caso o retorno contenha erros.
(4) - Código da estágio do cliente, conforme tabela de Estágios do cliente.
(5) - Código do tipo de data da ação, conforme tabela de Tipos de data da ação.
(6) - Estes campo só terá valor caso o campo tipo_data_acao tenha o valor "D", e o formato utilizado será dd/mm/yyyy, exemplo "01/01/2012".
(7) - Código da estágio do assunto, conforme configuração da conta Tiny, estes código podem ser obtidos através da Lista de estágios de assuntos do CRM.
(8) - Código da situação do assunto, conforme tabela de Situções do Assunto.
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/crm.pesquisa.php';
$token = 'coloque aqui a sua chave da api';
$pesquisa = 'xxxxx';
$data = "token=$token&pesquisa=$pesquisa&formato=JSON";
enviarREST($url, $data);
function enviarREST($url, $data, $optional_headers = null) {
$params = array('http' => array(
'method' => 'POST',
'content' => $data
));
if ($optional_headers !== null) {
$params['http']['header'] = $optional_headers;
}
$ctx = stream_context_create($params);
$fp = @fopen($url, 'rb', false, $ctx);
if (!$fp) {
throw new Exception("Problema com $url, $php_errormsg");
}
$response = @stream_get_contents($fp);
if ($response === false) {
throw new Exception("Problema obtendo retorno de $url, $php_errormsg");
}
return $response;
}