Inicio » API SMS ES » Enviar SMS a una lista

Enviar SMS a una lista

POST
https://api.octopush.com/v1/public/sms-campaign-on-list/create

Codificación : UTF-8

Autentificación

Su “api-key” y “api-login” deben ser añadidos en las cabeceras.

Definición

Este servicio permite crear una campaña de SMS sobre una lista de contactos.

Este es un proceso asíncrono. Esto permite dar órdenes de envío sin sufrir un timeout. 4 servicios le permiten operar este tipo de envío:

  • Crear la campaña sobre una lista de contactos.
  • Obtener el estado de la campaña (calculando, lista para enviar, fallida)
  • Eliminar una campaña de lista
  • Validar el envío de una campaña de lista

Parámetros especiales

CampoTipoDescripción
textstringTexto del mensaje (de 1 a 1224 caracteres no unicode).
list_namestringNombre de la lista a ser utilizada en la campaña
typestringTipo de campaña : [“sms_vocal”]
senderstringEmisor del mensaje (si el usuario lo permite), 3-11 caracteres alfanuméricos (a-zA-Z0-9).
send_atstring‘Cuando quieras enviar la campaña de sms. Formato: DateTime ISO8601 (ej: “2018-10-03T07:42:39-07:00”).’
purposestringPropósito de la campaña: (transaccional/alerta o marketing) : [“alert”,”wholesale”]
with_repliesboolean“True” para recuperar las respuestas de los destinatarios
auto_optimize_textboolean(opcional) Transmitiendo este campo con valor “falso”, su texto no será optimizado por el robot Octopush (su mensaje podría contener caracteres unicode, o espacios inútiles que podrían aumentar el número de SMS necesarios para cada contacto).

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/sms-campaign-on-list/create' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "list_name": "my_list",
  "text":  "Este es un Mensaje Premium con mención STOP. STOP at 30101",
  "type": "sms_premium",
  "purpose": "wholesale",
  "sender": "Empresa X"
}'

Respuesta Servidor en JSON

Éxito : 201 CREATED

{
  "ticket_number": "sms_5f3fbce61266e" 
}

Error : 400 BAD REQUEST

{
  "code": 121,
  "message": "Falta la mención STOP."
}