Mensajes transaccionales – especificación

URL de la API

URL a la que se envían las solicitudes HTTP:

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

Nota

Si la solicitud no llega a su destino, repítala en el servidor de respaldo backup1.bulkgate.com.

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

Precaución

Está terminantemente prohibido utilizar los SMS transaccionales con fines promocionales o de marketing. Solo deben utilizarse con fines de notificación, es decir, como notificación por SMS.

Nota

Si desea utilizar una ruta transaccional para enviar mensajes de notificación masivos, póngase en contacto con nuestro soporte. Podemos permitir esta opción si existe un motivo justificado.

Advertencia

Los destinatarios que se hayan dado de baja recibirán el mensaje (la baja (opt-out) solo se aplica a los mensajes promocionales).

Tabla de parámetros

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
application_id	Application_ID	Sí	-
application_token	Token de autenticación de la aplicación	Sí	-
tag	Etiqueta de identificación personal	No	-
primary_channel	Canal principal que se utiliza primero en la cascada	No	`sms`
phone_number	Número de teléfono del destinatario	Sí	-
country	Indique los números de los destinatarios en formato internacional (con prefijo, p. ej. `420`) o añada el código de país (`775123456` + `CZ` = `420775123456`). Consulte un ejemplo de lo que exige cada país. Si el valor es `null`, se utiliza la zona horaria que tenga configurada para completar la información	No	`null`
schedule	Programe la fecha y la hora de envío como marca de tiempo Unix. Consulte los ejemplos a continuación.	No	`null`
channels	Array asociativo de objetos de canal	Sí	Objeto de canal
duplicates_check	Seleccione `on` para evitar el envío de mensajes duplicados al mismo número de teléfono. Los mensajes con el mismo texto enviados al mismo número se eliminarán si el intervalo entre ellos es inferior a 5 minutos. Con `off` no se elimina ningún duplicado.	No	`false`

Objeto del canal Viber

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
sender	Nombre del remitente	No	-
expiration	Tiempo tras el cual el mensaje caduca	No	`3600`
button_caption	Texto del botón	No	`OK`
button_url	URL del botón	No	`#`
image	URL de la imagen incluida en el mensaje	No	`null`
image_zoom	¿Se puede ampliar la imagen?	No	`false`
text	Texto del mensaje. Es posible añadir a la plantilla variables del array `variables` (otro parámetro) `Hello <first_name> <last_name> ....`	Sí	-
variables	Array asociativo para añadir variables al texto, p. ej. `{"first_name": "John", "last_name": "Doe"}`	No	`[]`

Objeto del canal SMS

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
sender_id	ID de remitente, consulte Tipo de ID de remitente	No	`gSystem`
sender_id_value	Valor del remitente - `gOwn` (p. ej. "420 777 777 777"), `gText` (p. ej. "BulkGate"), `gProfile` (p. ej. "423"), `gMobile` o `gPush` (KEY)	No	`''`
unicode	`Yes`/`true`/`1` para SMS Unicode, `no`/`false`/`0` para SMS de 7 bits	No	`false`
text	Texto del SMS (máx. 612 caracteres o 268 caracteres si Unicode está activado), codificación UTF-8. Es posible añadir a la plantilla variables del array `variables` (parámetro adicional) `Hello <first_name> <last_name> ....`	Sí	-
variables	Array asociativo para añadir variables al texto, p. ej.: `{"first_name": "John", "last_name": "Doe"}`	No	`[]`

Tipo de ID de remitente `sender_id`

VALOR	DESCRIPCIÓN
`gSystem`	Número del sistema
`gShort`	Código corto
`gText`	Remitente de texto
`gMobile`	Mobile Connect
`gPush`	Mobile Connect push - Envía una notificación a su aplicación Mobile Connect
`gOwn`	Número propio (requiere la verificación del número)
`gProfile`	ID del perfil de remitente
`<int>`	ID del perfil de remitente

Ejemplo de una solicitud completa:

POST /api/1.0/integration/transactional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "tag": "", "primary_channel": "sms", "phone_number": "420777777777", "country": "cz", "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "text": "test <variable_1>", "variables": { "variable_1": "name" } }, "sms": { "sender_id": "gSystem", "sender_id_value": "BulkGate", "unicode": false, "text": "test <variable_1>", "variables": { "variable_1": "name" } } } }

La respuesta a este comando puede ser:

En caso de éxito

{ "data": { "status": "accepted", "message_id": "omni-############", "part_id": [ "omni-##############" ], "number": "420777777777", "channel": "sms" } }

En caso de error:

{ "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 }

Donde:

type y error (descripción del error) se pueden consultar en la tabla de tipos de error
code representa el error HTTP
detail es información adicional sobre el error

Todos los tipos de error de Simple API y Advanced API se encuentran aquí.

¿Le ha resultado útil esta página?

Preguntar a la IA Copiado