Inicio » API SMS Octopush » API SMS de Voz » Enviar SMS de Voz a una lista

Enviar SMS de Voz a una lista

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

Codificación : UTF-8

Autentificación

Los identificadores “api-key” y “api-login” deben añadirse en las cabeceras.

Definición

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

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

  • Creación de la campaña de Voz SMS en una lista de contactos.
  • Obtener el estado de la campaña (calculando, listo para enviar, fallido)
  • Eliminar una campaña de SMS de voz en la lista
  • Validar el envío de una campaña de SMS de voz en la lista

Parámetros especiales

NombreTipoDescripcion
list_namestringNombre de la lista a ser utilizada en la campaña
textstringTexto del mensaje (de 1 a 1224 caracteres no unicode).
recipientsarrayLista de objetos de contacto array de objetos:
[
  {
    "phone_number": "+111222233334444",
    "first_name": "Alex",
    "last_name": null,
    "param1": null,
    "param2": null,
    "param3": null,
    "param4": null,
    "param5": null,
  },
  ...,
  {
    "phone_number": "+2222333334444555",
    "param1": "John",
  }
]
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”]
voice_genderstringGenero de la voz [‘male’, ‘female’]
voice_languagestringIdioma de la voz [‘en-US’, ‘en-GB’, ‘el-GR’, ‘pl-PL’, ‘hu-HU’, ‘sv-SE’, ‘de-DE’, ‘es-ES’, ‘es-LA’, ‘fr-FR’, ‘it-IT’, ‘pt-BR’, ‘ru-RU’]
simulation_modeboolean(opcional) Si este valor es “true”, su petición será simulada y recibirá un resultado falso. Sólo se ejecutarán algunas validaciones mínimas.
request_idstring(optional) Para evitar enviar la misma solicitud varias veces, configure un ID de solicitud. En caso de que se detecte la duplicación, se devolverá un error de validación.

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/voice-campaign-on-list/create' \ 
-H 'Content-Type: application/json' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache' \ 
-d '{
  "recipients": [
   {
     "phone_number": "+34932200520",
     "first_name": "Alex"
    }
  ],
  "text": "{first_name}, tienes un SMS de voz",
  "sender": "12345",
  "voice_gender": "female",
  "voice_language": "es-ES"
}'

Respuesta Servidor en JSON

Éxito : 201 CREATED

{
   "ticket_number": "voice_5f44ebf9e47b7"
}

Error : 400 Bad Request

{
   "code": 400,
   "message": "Payload validation error.",
   "errors":
   {
      "voice_language": 
      {
         "code": 442,
         "message": "Voice language not supported."
      }
   }
}