Para poder enviar um SMS através da plataforma, o cliente nos enviará uma solicitação à página web indicada posteriormente utilizando certos parâmetros (texto a ser enviado, número do telefone do destinatário, remetente, etc...) e retornaremos uma resposta de confirmação de que tudo há ido bem, ou uma resposta de erro em caso contrario.
A seguir se indicará detalhadamente as opções de configuração disponíveis, o URL a que se deve chamar e os parâmetros admitidos.
Para gerar o URL, o cliente deverá fazer uma chamada GET à seguinte direção:
https://gateway.nrsgateway.com/send.php
Parâmetros da chamada:
text
Texto da mensagem. Pode ter no máximo 160 caracteres, caso não se especifique que a mensagem seja multiparte. (Ver parâmetros. 'parts'). O texto tem que estar codificado em UTF-8
to
Número do telefone celular destinatário da mensagem. Deve incluir o prefixo (p. ex. Brasil 5566666666). Este campo permite indicar destinatários múltiplos, para isto há que separar os números de telefone com um espaço. (P. ex. 55666666666 55666666667 556666666668)
from
Texto do Remetente (opcional), esta etiqueta será composta por 15 números ou 11 caracteres alfanuméricos.
username
Código do cliente (número do celular registrado na NRS Gateway)
password
Senha do cliente na nrsgateway.com
coding
Os valores possíveis são 0 e 8. O valor 0 para envios normais com codificação GSM7 e 160 caracteres por mensagem e o valor 8 para a codificação UCS2 (UTF16) e 70 caracteres por mensagem.
dlr-mask(opcional.)
Para receber confirmações de recebimento o valor deve ser sempre em 8, caso não seja necessário, não há que especificar este parâmetro.
fSend (opcional.)
Data do envio da mensagem. Caso seja necessário enviar mensagens programadas se pode especificar a data do envio indicando a data em formato YYYYmmddHHiiss (p. ex. 20130215142000 seria o dia 15 de fevereiro de 2013 às 14:20h). No caso de envio imediato, não há que especificar este parâmetro.
parts(opcional.)
Indica o número máximo de partes nas quais se dividirá a mensagem para seu envio. Esta variável tem um valor padrão 1, portanto, se não for especificada e se enviar uma mensagem com mais de 160 caracteres com a codificação 0, a mensagem falhará. Há que ter em conta que as mensagens concatenadas somente podem ter 153 caracteres por parte e que cada parte é tarifada como um envio. O servidor utilizará o mínimo de partes que seja necessário para realizar o envio do texto ainda que o número de partes especificadas seja superior ao necessário. No caso em que o número de partes seja inferior ao necessário para o envio de texto, o envio falhará com o erro 105.
trsec (opcional.)
Os valores possíveis são 1 e 0. Com o valor 0 o servidor não modifica nenhum dos caracteres da mensagem, este é o valor padrão. Com o valor 1 o servidor se encarrega de transformar os caracteres comuns não válidos do GSM7 em caracteres válidos com a seguinte tabela de tradução: 'á' => 'a', 'í'=>'i', 'ó'=>'o', 'ú'=>'u', 'ç'=>'Ç', 'Á'=>'A', 'Í'=>'I', 'Ó'=>'O', 'Ú'=>'U', 'À'=>'A', 'È'=>'E', 'Ì'=>'I', 'Ò'=>'O', 'Ù'=>'U', 'º' => '', 'ª' => '', 'Õ' => 'O', 'õ' => 'o', 'â' => 'a', 'ê' => 'e', 'î'=>'i', 'ô'=>'o', 'û'=>'u', 'Â'=>'A', 'Ê'=>'E', 'Î'=>'I', 'Ô'=>'O', 'Û'=>'U', 'ã' => 'a', 'Ã' => 'A'
Exemplo de chamada:
A senha (password) e o código do cliente (nome de usuário) serão proporcionados pela empresa. Deve-se ressaltar que com o fim de aumentar a segurança do sistema, o cliente deverá indicar a IP de onde irá conectar-se, somente se permitirão envios da IP indicada pelo cliente.
Como se pode ver, a resposta que a plataforma retorna ante uma solicitação de envio de SMS terá a seguinte sintaxe:
https://gateway.plusmms.net/send.php?username=tu_user &password=tu_login&to=3465467445+34627455334+34627545454&text=Prueba+de+envio&from=TEST&coding=0&dlr-mask=8
Em caso de erro, retornará uma mensagem com a descrição do motivo do erro.