Inicio » API SMS Octopush » Envío SMS Personalizado (Publipostage)

Envío SMS Personalizado (Publipostage)

POST
https://api.octopush.com/v1/public/sms-campaign/send

Definición

Esta opción le permite personalizar sus SMS para cada uno de sus destinatarios.
Puede realizar esta personalización por su cuenta, pero para ello debe enviarnos tantas solicitudes como números de teléfono tenga, lo que puede llevar varios minutos dependiendo del tamaño de sus listas.
Gracias a la opción de publipostage de Octopush, su envío sólo tardará unos segundos para todos sus contactos.

Campos dinámicos :

  • {first_name} : String, [50 chars max]
  • {last_name} : String, [50 chars max]
  • {param1} : String, [50 chars max]
  • {param2} : String, [50 chars max]
  • {param3} : String, [50 chars max]
  • {param4} : String, [50 chars max]
  • {param5} : String, [50 chars max]

Codificación UTF-8

Parametros Especiales

NombreTipoDescripción
textstringTexto del mensaje (de 1 a 1224 carácteres).
recipientsarrayObjetos Array Lista de objetos contacto:
[
  {
    "phone_number": "+111222233334444",
    "first_name": "Alex",
    "last_name": "Smith",
    "param1": "M",
    "param2": null,
    "param3": null,
    "param4": null,
    "param5": null,
  },
  ...,
  {
    "phone_number": "+2222333334444555",
    "param1": "John",
  }
]
typestringTipo de campaña: [“sms_premium”,”sms_low_cost”]
senderstringQuien envía el mensaje (si el usuario lo permite), 3-11 caracteres alfanuméricos (a-zA-Z0-9).
send_atstring‘Cuando desee enviar la campaña SMS. Formato: DateTime ISO8601 (for ex: “2018-10-03T07:42:39-07:00”).’

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/sms-campaign/send' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "recipients": [
    {
      "phone_number": "+336000123",
      "first_name": "Alexandra",
      "last_name": "Robinson",
      "param1": "Mrs",
      "param2": "Dr Collins",
      "param3": "3:30 pm"
    },
    {
      "phone_number": "+336001234",
      "first_name": "Paul",
      "last_name": "McDonald",
      "param1": "Mr",
      "param2": "Dr Howard",
      "param3": "4:00 pm"
    }
  ],
  "text": "Hola {param1} {first_name} {last_name}, no olvide su cita con {param2} a las {param3}. STOP al 30101",
  "type": "sms_premium",
  "purpose": "alert",
  "sender": "Medic"
}'

Retorno JSon

Éxito : 201 CREATED

{
  "sms_ticket": "sms_5f3fbce61266e",
  "number_of_contacts": 1,
  "total_cost": 5.00502839 
}

Error : 400 Bad Request

{
  "code": 121,
  "message": "La mención STOP falta en el mensaje."
}