Documentação da API

Seu sistema deve realizar uma chamada para os nossos endpoints, enviando os parâmetros por meio de GET ou POST.

O retorno para cada chamada será um JSON cujo formato é detalhado ao longo desta documentação.

Autenticação

Todas as requisições à API devem utilizar cabeçalhos Basic Authorization. Neste campo deve ser informado seu usuário e senha cadastrados em nosso site. Caso haja erro na autenticação, o respectivo código de erro será retornado.

            Authorization: Basic dXN1YXJpbzpzZW5oYQ=

O valor após a palavra Basic é uma chave Base64 de seu usuário e senha. A maioria das ferramentas têm implementação para esta autenticação.

Gerenciamento de múltiplas contas de envio

Com apenas um cadastro, você pode gerenciar o envio de SMS de diversas empresas.

Para isso, basta informar o parâmetro cnpj nas requisições GET ou POST. Este parâmetro é opcional, caso não seja informado, o sistema usará automaticamente a empresa padrão cadastrada.

Tabela de Caracteres

Caracteres básicos

Mensagens que possuem somente caracteres que estão na tabela abaixo, são cobradas a cada 160 caracteres. Caso a mensagem possua um ou mais caracteres que não estão na tabela abaixo e definido o parâmetro "utf-8", a cobrança é feita a cada 70 caracteres, conforme especificação do protocolo na rede das operadoras.

Tabela de caracteres básicos.
Space	!	"	#	$	%	&	'	(	)	*
+	,	-	.	/	0	1	2	3	4	5
6	7	8	9	:	;	<	>	=	?	@
A	B	C	D	E	F	G	H	I	J	K
L	M	N	O	P	Q	R	S	T	U	V
W	X	Y	Z	_	`	a	b	c	d	e
f	g	h	i	j	k	l	m	n	o	p
q	r	s	t	u	v	w	x	y	z

Observações:

Para habilitar do uso de acentos e caracteres especiais adicione na chamada o parâmetro utf8=1.
Caso a operadora destino não aceite acentos e caracteres especiais, nossa plataforma faz automaticamente para os nossos clientes a substituição dos mesmos, por exemplo: á para a, é para e, etc.

Caracteres estendidos

Os seguintes caracteres também estão disponíveis, mas são contados como dois caracteres na mensagem SMS:

Tabela de caracteres estendidos.
^	{	\|	\	[	]	~	\|	€

Textos grandes (concatenação)

O protocolo utilizado na rede das operadoras possui os limites de 70 ou 160 caracteres, para mensagens com e sem caracteres especiais, respectivamente. É possível enviar mensagens maiores com a utilização de concatenação, onde o aparelho reagrupa as mensagens ao recebê-las.

Para para ativar a concatenação, basta enviar juntamente com a chamada o parâmetro concatenation=1.

É importante notar que, apesar de aparecerem no aparelho como uma única mensagem grande, as mensagens continuam trafegando na rede das operadoras individualmente, e neste caso, continuamos sendo cobrados e cobrando individualmente, a cada 63 ou 160 (dependendo dos caracteres utilizados). Lembrando que ao utilizar concatenação parte dos caracteres (70 ou 160) são utilizados pelo header.

Observação: Nos casos de operadoras que não suportam a funcionalidade de concatenação, nós enviaremos as mensagens separadamente, sem concatenar, e incluindo indicadores de ordem automaticamente para nossos clientes. Ex: