Inicio » API SMS Octopush » Lista de Parámetros

Lista de Parámetros

Aquí tiene una lista de los parámetros disponibles para usar con nuestra API de SMS.

ADVERTENCIA: Los parámetros que no son obligatorios tienen un valor predeterminado.

Autenticación

La api-key y api-login deben añadirse en las cabeceras

NombreTypeDescripción
senderstringEmisor del mensaje (si el usuario lo permite), 3-11 caracteres alfanuméricos (a-zA-Z0-9).
send_atstring‘Fecha cuando quieres enviar la campaña de sms. Formato: DateTime ISO8601 (ej: “2018-10-03T07:42:39-07:00”).’
textstringTexto del mensaje (de 1 a 1224 caracteres)
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",
  }
]
typestringTipo de la campaña: [“sms_premium”,”sms_low_cost”]
purposestringPropósito de la campaña: [“alert”,”wholesale”]
with_repliesboolean“True” para recuperar las respuestas de los destinatarios
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. Cada request_id expira luego de 24 horas.
auto_optimize_textboolean(opcional) Si este campo se transmite y tiene el valor “falso” su texto no será optimizado por el robot Octopush (su mensaje podría contener caracteres unicode, o espacios innecesarios que podrían aumentar el número de SMS necesarios para cada uno de sus contactos).

Especificaciones SMS de Voz

voice_languagestringIdiomas disponibles [‘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’]
voice_genderstringGénero de la voz [“male”, “female”]

Especificaciones Consultas de Crédito

with_detailsboolean(opcional) Ajustar los detalles de los packs en su portfolio.
product_namestring(opcional) Nombre del producto en el que desea obtener su saldo(sms_low_cost, sms_premium, vocal_sms, hlr). También debe indicar el country_code.

Especificaciones Gestión de Lista de Contactos

Especificaciones Gestión Subcuentas

Códigos de Solicitud SHA1

KeysCampos correspondientes
Tsms_text
Rsms_recipients
Msms_mode
Ysms_type
Ssms_sender
Dsending_date
arecipients_first_names
brecipients_last_names
csms_fields_1
dsms_fields_2
esms_fields_3
Wwith_replies
Ntransactional
Qrequest_id