Mensajes promocionales – especificación

URL de la API

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

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

Nota

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

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

Tabla de parámetros

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
application_id	ID de aplicación	Sí	-
application_token	Token de autenticación de la aplicación	Sí	-
tag	Etiqueta de identificación personal	No	-
messages	Array de mensajes	Sí	Objeto de mensaje

Objeto de mensaje

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
primary_channel	Canal principal que se utiliza en primer lugar 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 (`777777777` + `CZ` = `420777777777`). Consulte el ejemplo de solicitud con el país. Si el valor es `null`, se utilizará la zona horaria que tenga configurada para completar la información	No	`null`
schedule	Programe la fecha y la hora de envío en unix timestamp, Consulte los ejemplos a continuación	No	`null`
channels	Array asociativo de objetos de canal	Sí	Objeto de canal

Objeto del canal Viber

NOMBRE DEL PARÁMETRO	VALOR	OBLIGATORIO	VALOR PREDETERMINADO
sender	Nombre del remitente	No	-
expiration	Tiempo tras el cual caduca el mensaje	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) `Hola <first_name> <last_name> ....`	Sí	-
variables	Array asociativo para añadir variables al texto, p. ej. `{"first_name": "Juan", "last_name": "García"}`	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 se activa Unicode), codificación UTF-8. Es posible añadir a la plantilla variables del array `variables` (parámetro adicional) `Hola <first_name> <last_name> ....`	Sí	-
variables	Array asociativo para añadir variables al texto, p. ej.: `{"first_name": "Juan", "last_name": "García"}`	No	`[]`

Tipo de ID de remitente `sender_id`

VALOR	DESCRIPCIÓN
`gSystem`	Número del sistema
`gShort`	Short code
`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 solicitud completa:

POST /api/1.0/integration/promotional HTTP/1.1 Host: portal.bulkgate.com Content-Type: application/json { "application_id": 451, "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj", "tag": "", "messages": [ { "primary_channel": "sms", "phone_number": "420777777777", "country": "cz", "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "button_caption": "OK", "button_url": "#", "image": "", "image_zoom": false, "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" } } } }, { "primary_channel": "sms", "phone_number": "420777777778", "country": "cz", "channels": { "viber": { "sender": "BulkGate", "expiration": 3600, "button_caption": "OK", "button_url": "#", "image": "", "image_zoom": false, "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": { "total": { "status": { "sent": 0, "accepted": 2, "scheduled": 0, "error": 0, "blacklisted": 0, "invalid_number": 0, "invalid_sender": 0 } }, "response": [ { "status": "accepted", "message_id": "############-0", "part_id": [ "############-0" ], "number": "420777777777", "channel": "sms" }, { "status": "accepted", "message_id": "############-1", "part_id": [ "############-1" ], "number": "420777777778", "channel": "sms" } ] } }

En caso de error:

{ "data": { "total": { "status": { "sent": 0, "accepted": 0, "scheduled": 0, "error": 0, "blacklisted": 0, "invalid_number": 0, "invalid_sender": 0 } }, "response": [] } }

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

Donde:

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

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

¿Le ha resultado útil esta página?

Preguntar a la IA Copiado