Conceitos-chave

Tipos de chamadas

Programe seu sistema para efetuar uma chamada à API da Talk SMS, conforme o tipo de integração:

Tipos de integração	Detalhes
HTTP	sistema deve realizar uma chamada para a URL, enviando os parâmetros por meio de variáveis GET ou POST: https://api-sms.talkcomm.com.br/api/[nome do metodo]/[nome da ação].
Web Services	A requisição é feita por uma chamada JSON ou XML ou parâmetros ou tag forms html, obtendo como retorno uma string de texto com formato detalhado ao longo desta documentação.

Autenticação

Em todas as chamadas, devem ser identificadas sua conta e senha de integração que enviamos por e-mail. Caso haja erro na autenticação, o respectivo código de erro será retornado.

Nome	Obrigatório	Formato	Descrição
Usuario	Sim	string (20)	Nome da conta utilizada pelo cliente.
Senha	Sim	string (20)	Senha de integração da conta.

Parâmetro Id

Ao enviar um SMS, recomendamos que você utilize o parâmetro Id. Ele serve como um identificador único de sua mensagem em nossa plataforma e pode ser utilizado para consulta de status ou mesmo para proteção contra envios duplicados.

O parâmetro Id também pode ser substituido pelo Código de Integração presentes quando postados via JSON ou XML e também nas consultas de status dos SMS.

Formato e codificação dos campos

Fique atento à formatação e codificação dos diferentes tipos de campos utilizados nas chamadas:

Tipos de Campo	Detalhes
string	As variáveis devem ser URL Encoded, especialmente quando se trata do conteúdo da mensagem.
Data e hora	dd/mm/aaaa hh:mm:ss
Celular	Código de país + código de área + número. Exemplo: 555199887766.
Mensagem	string alfanumérica com um limite de 150 caracteres.

Tratamento do retorno das chamadas

A cada chamada de integração, diversos códigos de retorno serão retornados. Recomendamos que você utilize em seu código-fonte uma estrutura do tipo switch/case para tratamento desses retornos. Exemplo:

	$retorno = substring($retornoIntegracao, 0, 3)

    switch ($retorno) {
        case 000:
        	/*mensagem enviada com sucesso*/
        break;
        case 080:
        	/*mensagem com Id repetido*/
        break;
        default:
        	/*retorno não identificado*/
        break
	}

Status do SMS

Status	Detalhes
Salvo para envio – SMS agendado na plataforma Talk SMS para envio em data e hora futura (ainda não enviado à operadora).
SMS entregue com sucesso à operadora de destino.
Recebido	Operadora confirma o recebimento pelo celular de destino.
Não recebido	Operadora confirma o não recebimento pelo celular de destino.
Sem informação	Operadora não retornou informação sobre o envio.
Não enviado à operadora – SMS registrado na plataforma Talk SMS, porém bloqueado por nossas ferramentas de inteligência de envio.
Fora do plano de numeração	Celular destinatário é inválido (número não existe).
Blacklist	O celular destinatário do SMS foi encontrado em uma lista de bloqueio da conta.
Limpeza preditiva	O celular destinatário foi bloqueado por nosso exclusivo algoritmo de limpeza preditiva de base (para mais informações, consulte nossa equipe).
Cancelado	SMS com envio cancelado pelo usuário ou pelo sistema de integração.