Skip to content
Inicio » API SMS Octopush » API SMS de Voz » Envio SMS de Voz Programado

Envio SMS de Voz Programado

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

Codificación : UTF-8

Autentificación

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

Definición

Permite enviar un SMS de voz en diferido indicando la fecha de envío en formato ISO.

Parámetros especiales

NombreTipoDescripción
textstringTexto del mensaje (de 1 a 1224 caracteres no unicode).
recipientsarrayLista de objetos de contacto array de objetos:
[
  {
    "phone_number": "+111222233334444",
    "param1": "Alex",
    "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. El request_id expira luego de 24 horas.

Ejemplo Curl

curl -X POST \ 
'https://api.octopush.com/v1/public/voice-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",
         "param1": "Alex"
      }
   ],
   "text": "Tienes un SMS de voz",
   "purpose": "alert",
   "sender": "12345",
   "send_at": "2018-10-03T07:42:39-07:00",
   "voice_gender": "female",
   "voice_language": "es-ES"
}'

Respuesta Servidor en JSON

Éxito : 201 CREATED

{
  "ticket_number": "voice_5f44ebf9e47b7",
  "number_of_contacts": 1,
  "total_cost": 0.05,
  "estimated_duration": 30,
  "residual_credit": 149.95
}

Error : 400 Bad Request

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