Incluir Ação no Assunto do CRM API 2.0

Serviço destinado a fazer a inclusão de ação no assunto no CRM.

Parâmetros do serviço

ElementoTipoOcorrênciaDescrição
tokenstringobrigatórioChave gerada para identificar sua empresa
acao (1)intobrigatórioDados da ação conforme layout
formatostringobrigatórioFormato do retorno (json ou xml)

(1) - Layout do parâmetro assunto

CampoTipoTamanhoOcorrênciaDescrição
acaoobject-obrigatórioElemento utilizado para representar uma ação
acao.id_assuntoint-obrigatórioNúmero de identificação do assunto no Tiny
acao.descricao_acaostring-obrigatórioDescrição da ação
acao.tipo_data_acaostring1obrigatórioCódigo, conforme tabela de Tipos de data da ação.
acao.data_acao(1)date20opcionalData da ação
acao.situacao_acao(2)string-opcionalCódigo conforme tabela de Situações da ação.

(1) - O valor deste campo somente será considerado caso o campo tipo_data_acao tenha o valor "D", e o formato utilizado será dd/mm/yyyy, exemplo "01/01/2012".
(2) - Campo opcional, caso não seja enviado valor, será assumido "0" como valor padrão.

Retorno do serviço

ElementoTipoTamanhoOcorrênciaDescrição
retornoobject-obrigatórioElemento raiz do retorno
retorno.status_processamentoint-obrigatórioConforme tabela "Status de Processamento"
retorno.statusstring-obrigatórioContém o status do retorno “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.codigo_erro (1)int-obrigatórioConforme tabela "Códigos de erro"
retorno.erros[ ] (1) (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.registros (2)list-condicionalLista de resultados da inclusão
retorno.registros[ ].registro (2)object-condicionalElemento utilizado para representar uma ação.
retorno.registros[ ].registro.sequenciaint-condicionalNúmero sequencial utilizado para identificar cada contrato (1).
retorno.registros[ ].registro.statusstring-condicionalContém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo
retorno.registros[ ].registro.codigo_erroint-condicionalConforme tabela "Códigos de erro"
retorno.registros[ ].registro.erros[ ] (3)list-condicional [0..n]Contém a lista dos erros encontrados.
retorno.registros[ ].registro.erros[ ].errostring-condicionalMensagem contendo a descrição do erro
retorno.registros[ ].registro.idint-condicionalNúmero de identificação da açõa no Tiny

Exemplos do parâmetro assunto

Exemplos do parâmetro assunto em JSON

Exemplos do parâmetro assunto em XML 

<?xml version="1.0" encoding="UTF-8"?>
<acao>
  <id_assunto>1235678</id_assunto>
  <descricao_acao>Ligar</descricao_acao>
  <tipo_data_acao>Q</tipo_data_acao>
  <situacao_acao>0</situacao_acao>
</acao>

Exemplos de chamada da API

Exemplos da chamada em REST 


$url = 'https://api.tiny.com.brapi2/crm.incluir.acao.assunto.php';
$token = 'coloque aqui a sua chave da api';
$acao = '<acao>...</acao>';
$data = "token=$atoken&acao=$acao&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;
}

Exemplos da chamada em SOAP 


$client = new nusoap_client("https://api.tiny.com.brapi2.php?wsdl", true);
$client->soap_defencoding = 'UTF-8';
$client->decode_utf8 = false;

$result = $client->call("incluirAcaoAssuntoCRM", array('token' => 'xxxxx','acao'=>'<acao>...</acao>','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

Exemplos do retorno do serviço em JSON

Exemplos do retorno do serviço em XML 

<?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>
  <registros>
    <registro>
      <sequencia>1</sequencia>
      <status>Erro</status>
      <codigo_erro>30</codigo_erro>
      <erros>
        <erro>Registro em duplicidade</erro>
      </erros>
    </registro>
  </registros>
</retorno>

<?xml version="1.0" encoding="UTF-8"?>
<retorno>
  <status_processamento>3</status_processamento>
  <status>OK</status>
  <registros>
    <registro>
      <sequencia>1</sequencia>
      <status>OK</status>
      <id>37644545</id>
    </registro>
  </registros>
</retorno>