SMS transacional – especificação (Advanced API 1.0)

Cuidado

É estritamente proibido utilizar notificações SMS para fins promocionais/de marketing. Devem ser utilizadas apenas para fins de notificação, como SMS transacional.

URL da API

URL utilizado para enviar pedidos HTTP:

https://portal.bulkgate.com/api/1.0/advanced/transactional

Nota

Se o pedido não chegar ao destino, repita-o no servidor de reserva backup1.bulkgate.com.

Métodos HTTP suportados

POST - application/json

POST /api/1.0/advanced/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json

Tabela de parâmetros

NOME DO PARÂMETRO	VALOR	OBRIGATÓRIO	VALOR PREDEFINIDO
application_id	ID da aplicação	Sim	-
application_token	Token da aplicação	Sim	-
number	Número do destinatário	Sim ou `admin`	-
admin	Número do administrador BulkGate que recebe a notificação. Mais informações	Sim ou `number`	-
text	Texto da mensagem SMS (máx. 612 caracteres, ou 268 caracteres se o Unicode estiver ativado), codificação UTF-8. É possível adicionar ao modelo variáveis do array `variables` (outro parâmetro) `Olá <first_name> <last_name> ....`	Sim	-
variables	Array associativo para adicionar variáveis ao texto, por exemplo: `{"first_name": "John", "last_name": "Doe"}`	Não	`[]`
unicode	`Yes`/`true`/`1` para SMS Unicode, `no`/`false`/`0` para SMS de 7 bits	Não	`false`
sender_id	ID do remetente, consulte Tipo de remetente	Não	`gSystem`
sender_id_value	Valor do remetente - `gOwn` (p. ex. "420 777 777 777"), `gText` (p. ex. "BulkGate"), `gProfile` (p. ex. "423"), `gMobile` ou `gPush` (CHAVE)	Não	`null`
country	Indique os números dos destinatários em formato internacional (com prefixo, p. ex. `420`), ou adicione o código do país (`777777777` + `CZ` = `420777777777`). Consulte o exemplo de pedido com o país. Se o valor for `null`, será utilizado o fuso horário que definiu para completar a informação	Não	`null`
schedule	Agende a data e a hora de envio em unix timestamp ou ISO 8601.	Não	Agora
duplicates_check	Selecione `on` para evitar o envio de mensagens duplicadas para o mesmo número de telefone. As mensagens com o mesmo texto enviadas para o mesmo número serão removidas se o intervalo entre elas for inferior a 5 min. Com `off`, nenhum duplicado é removido.	Não	`off`
tag	Etiqueta da mensagem para posterior pesquisa pelo utilizador.	Não	-

Tipo de remetente `sender_id`

VALOR	SIGNIFICADO
`gSystem`	Número do sistema
`gShort`	Short Code
`gText`	Remetente de texto
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push - Envia uma notificação para a aplicação Mobile Connect
`gOwn`	Número próprio (requer verificação do número)
`gProfile`	ID de perfil BulkGate
`<int>`	ID de perfil BulkGate

Exemplo de pedido

POST /api/1.0/advanced/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "number": "420777777777", "unicode": true, "text": "Olá, <first_name> <last_name>", "variables": {"first_name": "John", "last_name": "Doe"}, "sender_id": "gText", "sender_id_value": "BulkGate", "country": "pt", "schedule": "2018-05-14T18:30:00-01:00" }

Resposta

Em caso de sucesso:

{ "data": { "status": "accepted", "sms_id": "tmpde1bcd4b1d1", "part_id": [ "tmpde1bcd4b1d1_1", "tmpde1bcd4b1d1" ], "number": "420777777777" } }

Em que:

part_ID é o array de ID das partes da mensagem longa original, que foi dividida por exceder o limite de 160 caracteres de uma única mensagem. Mais informações aqui.

Em caso de erro:

{ "type": "invalid_phone_number", "code": 400, "error": "Invalid phone number", "detail": null }

{ "type": "unknown_identity", "code": 401, "error": "Unknown identity / unauthorized / empty application_id", "detail": null }

Em que:

type e error (descrição do erro) encontram-se na tabela de tipos de erros
code representa o código de erro HTTP
detail contém informações adicionais sobre o erro

Consulte todos os tipos de erros da Simple API e da Advanced API aqui.

Esta página foi útil?

Perguntar à IA Copiado