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
| Elemento | Tipo | Ocorrência | Descrição |
|---|---|---|---|
| token | string | obrigatório | Chave gerada para identificar sua empresa |
| acao (1) | int | obrigatório | Dados da ação conforme layout |
| formato | string | obrigatório | Formato do retorno (json) |
| Campo | Tipo | Tamanho | Ocorrência | Descrição |
|---|---|---|---|---|
| acao | object | - | obrigatório | Elemento utilizado para representar uma ação |
| acao.id_assunto | int | - | obrigatório | Número de identificação do assunto no Tiny |
| acao.descricao_acao | string | - | obrigatório | Descrição da ação |
| acao.tipo_data_acao | string | 1 | obrigatório | Código, conforme tabela de Tipos de data da ação. |
| acao.data_acao(1) | date | 20 | opcional | Data da ação |
| acao.situacao_acao(2) | string | - | opcional | Código conforme tabela de Situações da ação. |
| acao.usuario(3) | string | - | opcional | Login do usuário responsável pela 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.
(3) - Campo opcional, caso não seja enviado valor, não será atribuído usuário responsável à ação.
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 | - | obrigatório | 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.registros (2) | list | - | condicional | Lista de resultados da inclusão |
| retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar uma ação. |
| retorno.registros[ ].registro.sequencia | int | - | condicional | Número sequencial utilizado para identificar cada contrato (1). |
| retorno.registros[ ].registro.status | string | - | condicional | Contém o status do registro “OK” ou “Erro”. Para o caso de conter erros estes serão descritos abaixo |
| retorno.registros[ ].registro.codigo_erro | int | - | condicional | Conforme 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[ ].erro | string | - | condicional | Mensagem contendo a descrição do erro |
| retorno.registros[ ].registro.id | int | - | condicional | Número de identificação da açõa no Tiny |
Exemplos do parâmetro assunto
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/crm.incluir.acao.assunto.php';
$token = 'coloque aqui a sua chave da api';
$acao = '<acao>...</acao>';
$data = "token=$atoken&acao=$acao&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;
}
