Incluir Assunto do CRM API 2.0
Serviço destinado a fazer a inclusão de Assunto no CRM.
Parâmetros do serviço
Elemento | Tipo | Ocorrência | Descrição |
---|---|---|---|
token | string | obrigatório | Chave gerada para identificar sua empresa |
assunto (1) | int | obrigatório | Dados do assunto conforme layout |
formato | string | obrigatório | Formato do retorno (json) |
Campo | Tipo | Tamanho | Ocorrência | Descrição |
---|---|---|---|---|
assunto | object | - | obrigatório | Elemento utilizado para representar um assunto |
assunto.cliente | object | obrigatório | Elemento utilizado para representar o cliente | |
assunto.cliente.codigo (1) | string | 30 | opcional | Código do cliente |
assunto.cliente.nome (1) | string | 50 | obrigatório | Nome do cliente |
assunto.cliente.tipo_pessoa | string | 1 | opcional | Tipo de pessoa (F - Física, J - Jurídica, E - Estrangeiro) |
assunto.cliente.cpf_cnpj (1) | string | 18 | opcional | CPF ou CNPJ do cliente |
assunto.cliente.ie | string | 18 | opcional | Inscrição estadual do cliente |
assunto.cliente.rg | string | 10 | opcional | RG do cliente |
assunto.cliente.endereco | string | 50 | opcional | Endereço do cliente |
assunto.cliente.numero | string | 10 | opcional | Número do endereço do cliente |
assunto.cliente.complemento | string | 50 | opcional | Complemento do endereço do cliente |
assunto.cliente.bairro | string | 30 | opcional | Bairro do cliente |
assunto.cliente.cep | string | 10 | opcional | Cep do cliente |
assunto.cliente.cidade | string | 30 | opcional | Nome da cidade do cliente conforme a Tabela de Cidades |
assunto.cliente.uf | string | 2 | opcional | UF do cliente |
assunto.cliente.pais | string | 50 | opcional | Nome do país do cliente conforme Tabela de Países |
assunto.cliente.fone | string | 40 | opcional | Telefone do cliente |
assunto.cliente.email | string | 50 | opcional | Email do cliente |
assunto.cliente.atualizar_cliente (2) | string | 1 | opcional | ("S"-Sim, "N"-Não) Atualizar os dados no cadastro do cliente, caso não seja informado o valor padrão é "S" |
assunto.cliente.pessoa_contato[ ] | list | - | opcional | Elemento utilizado para representar uma passoa de contato |
assunto.cliente.pessoa_contato[ ].id_pessoa (3) | int | opcional | Número de identificação da pessoa de contato no Tiny | |
assunto.cliente.pessoa_contato[ ].nome (3) | string | 50 | opcional | Nome da pessoa de contato |
assunto.cliente.pessoa_contato[ ].telefone | string | 30 | opcional | Telefone da pessoa de contato |
assunto.cliente.pessoa_contato[ ].ramal | string | 10 | opcional | Ramal da pessoa de contato |
assunto.cliente.pessoa_contato[ ].email | string | 50 | opcional | e-mail da pessoa de contato |
assunto.cliente.pessoa_contato[ ].departamento | string | 20 | opcional | Departamento da pessoa de contato |
assunto.descricao_assunto | string | obrigatório | Título ou descrição do assunto | |
assunto.estagio_assunto4) | string | 1 | obrigatório | Código do estágio do assunto. |
assunto.acoes[ ] | list | obrigatório | Elemento utilizado para representar um conjunto de ações | |
assunto.acoes[ ].acao | object | obrigatório | Elemento utilizado para representar uma ação | |
assunto.acoes[ ].acao.descricao_acao | string | - | obrigatório | Descrição da ação |
assunto.acoes[ ].acao.tipo_data_acao | string | 1 | obrigatório | Código, conforme tabela de Tipos de data da ação. |
assunto.acoes[ ].acao.data_acao(5) | date | 20 | opcional | Data da ação |
assunto.acoes[ ].acao.situacao_acao(6) | string | - | opcional | Código conforme tabela de Situações da ação. |
(1) - Estes campos são utilizados para pesquisar se o cliente está cadastrado, caso esteja os demais campos são carregados do cadastro.
(2) - Caso o cliente não esteja cadastrado no Tiny, o mesmo será incluído desconsiderando o valor informado.
(3) - Estes campos são utilizados para pesquisar se a pessoa de contato está cadastrada no cliente.
(4) - 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.
(5) - 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".
(6) - Campo opcional, caso não seja enviado valor, será assumido "0" como valor padrã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[ ]registros[ ] (2) | list | - | condicional | Lista de resultados da inclusão |
retorno.registros[ ].registro (2) | object | - | condicional | Elemento utilizado para representar um assunto. |
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 do assunto no Tiny |
retorno.registros[ ].registro.acoes[ ] | list | - | condicional | Elemento utilizado para representar um conjunto de ações |
retorno.registros[ ].registro.acoes[ ].acao | object | - | condicional | Elemento utilizado para representar uma ação |
retorno.registros[ ].registro.acoes[ ].acao.id | int | - | condicional | Número de identificação da ação no Tiny |
Exemplos do parâmetro assunto
Exemplos de chamada da API
$url = 'https://api.tiny.com.br/api2/crm.incluir.assunto.php';
$token = 'coloque aqui a sua chave da api';
$assunto = '<assunto>...</assunto>';
$data = "token=$atoken&assunto=$assunto&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;
}