Obter Assunto do CRM API 2.0
Serviço destinado a obter os dados de um assunto.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
id | int | obrigatório | Número de identificação do assunto do CRM no Tiny |
formato | string | obrigatório | Formato do retorno (json ou xml) |
Retorno do serviço
Elemento | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
retorno | 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.assunto (2) | list | - | condicional | Elemento utilizado para representar um assunto. |
retorno.assunto.id | int | - | condicional | Número de identificação do assunto no Tiny |
retorno.assunto.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
retorno.assunto.cliente.id_cliente | int | - | obrigatório | Número de identificação do cliente no Tiny |
retorno.assunto.cliente.codigo | string | 30 | opcional | Código do cliente |
retorno.assunto.cliente.nome | string | 30 | obrigatório | Nome do cliente |
retorno.assunto.cliente.nome_fantasia | string | 30 | opcional | Nome fantasia do cliente |
retorno.assunto.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
retorno.assunto.cliente.cpf_cnpj | string | 18 | opcional | CPF ou CNPJ do cliente |
retorno.assunto.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
retorno.assunto.cliente.rg | string | 10 | opcional | RG do cliente |
retorno.assunto.cliente.endereco | string | 50 | opcional | Endereço do cliente |
retorno.assunto.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
retorno.assunto.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
retorno.assunto.cliente.bairro | string | 30 | opcional | Bairro do cliente |
retorno.assunto.cliente.cep | string | 10 | opcional | Cep do cliente |
retorno.assunto.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
retorno.assunto.cliente.uf | string | 30 | opcional | UF do cliente |
retorno.assunto.cliente.pais | string | 50 | opcional | Nome do País do cliente conforme Tabela de Países |
retorno.assunto.cliente.fone | string | 40 | opcional | Telefone do cliente |
retorno.assunto.cliente.estagio_cliente | string | 50 | condicional | Código do estágio do cliente, conforme tabela de Estágios do cliente |
retorno.assunto.texto_assunto | string | - | condicional | Texto do assunto do Crm |
retorno.assunto.proxima_acao | string | - | condicional | Próxima ação do assunto no Crm |
retorno.assunto.estagio_assunto(3) | string | 1 | condicional | Código do estágio do assunto. |
retorno.assunto.situacao_assunto | string | 1 | condicional | Código conforme tabela de Situções do Assunto |
retorno.assunto.status_negociacao | string | 1 | condicional | Código conforme tabela de Status de Negociação |
retorno.assunto.acoes[ ] | list | - | condicional | Lista de ações do assunto. |
retorno.assunto.acoes[ ].acao | object | - | condicional | Elemento utilizado para representar uma acao. |
retorno.assunto.acoes[ ].acao.id_acao | int | - | condicional | Número de identificação da ação do assunto do CRM no Tiny |
retorno.assunto.acoes[ ].acao.descricao_acao | string | - | condicional | Descrição da ação |
retorno.assunto.acoes[ ].acao.tipo_data_acao | string | 1 | condicional | Código, conforme tabela de Tipos de data da ação. |
retorno.assunto.acoes[ ].acao.data_acao(4) | date | 20 | condicional | Data da ação |
retorno.assunto.acoes[ ].acao.situacao_acao | string | - | condicional | Código conforme tabela de Situações da ação. |
(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) - 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) - 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".
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/crm.obter.assunto.php';
$token = 'coloque aqui a sua chave da api';
$id= 'xxxxx';
$data = "token=$token&id=$id&formato=XML";
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;
}
$client = new nusoap_client("https://api.tiny.com.br/api2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;
$result = $client->call("obterAssuntoCRM", array('token' => 'xxxxx','id'=>'xxxxx','formato'=>'XML'));
$res = array();
if ($client->fault) {
$retorno = $result['faultstring'];
} else {
$err = $client->getError();
if ($err) {
$retorno = $err;
} else {
$retorno = $result;
}
}
Exemplos de retorno da API
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>1</status_processamento>
<status>Erro</status>
<codigo_erro>2</codigo_erro>
<erros>
<erro>token invalido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>2</status_processamento>
<status>Erro</status>
<codigo_erro>21</codigo_erro>
<erros>
<erro>A consulta retornou mais registros que o permitido</erro>
</erros>
</retorno>
<?xml version="1.0" encoding="UTF-8"?>
<retorno>
<status_processamento>3</status_processamento>
<status>OK</status>
<assunto>
<id>123456</id>
<cliente>
<codigo>1235</codigo>
<nome>Contato Teste 2</nome>
<nome_fantasia>Fantasia Contato Teste 2</nome_fantasia>
<tipo_pessoa>F</tipo_pessoa>
<cpf_cnpj>22755777850</cpf_cnpj>
<ie/>
<rg>1234567890</rg>
<endereco>Rua Teste</endereco>
<numero>123</numero>
<complemento>sala 2</complemento>
<bairro>Teste</bairro>
<cep>95700000</cep>
<cidade>Bento Gonçalves</cidade>
<uf>RS</uf>
<fone>5430553808</fone>
<estagio_cliente>C</estagio_cliente>
</cliente>
<texto_assunto>Teste</texto_assunto>
<proxima_acao>Ligar</proxima_acao>
<estagio_assunto>2</estagio_assunto>
<situacao_assunto>A</situacao_assunto>
<status_negociacao>0</status_negociacao>
<acoes>
<acao>
<id_acao>15555</id_acao>
<descricao_acao>Realizar contato</descricao_acao>
<tipo_data_acao>Q</tipo_data_acao>
<situacao_acao>1</situacao_acao>
</acao>
<acao>
<id_acao>15556</id_acao>
<descricao_acao>Ligar</descricao_acao>
<tipo_data_acao>D</tipo_data_acao>
<data_acao>01/01/2015</data_acao>
<situacao_acao>0</situacao_acao>
</acao>
</acoes>
</assunto>
</retorno>