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
| Nombre | Type | Descripción |
|---|---|---|
| sender | string | Emisor del mensaje (si el usuario lo permite), 3-11 caracteres alfanuméricos (a-zA-Z0-9). |
| send_at | string | ‘Fecha cuando quieres enviar la campaña de sms. Formato: DateTime ISO8601 (ej: “2018-10-03T07:42:39-07:00”).’ |
| text | string | Texto del mensaje (de 1 a 1224 caracteres) |
| recipients | array | Lista 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",
}
] |
| type | string | Tipo de la campaña: [“sms_premium”,”sms_low_cost”] |
| purpose | string | Propósito de la campaña: [“alert”,”wholesale”] |
| with_replies | boolean | “True” para recuperar las respuestas de los destinatarios |
| simulation_mode | boolean | (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_id | string | (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_text | boolean | (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_language | string | Idiomas 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_gender | string | Género de la voz [“male”, “female”] |
Especificaciones Consultas de Crédito | ||
| with_details | boolean | (opcional) Ajustar los detalles de los packs en su portfolio. |
| product_name | string | (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
| Keys | Campos correspondientes |
|---|---|
| T | sms_text |
| R | sms_recipients |
| M | sms_mode |
| Y | sms_type |
| S | sms_sender |
| D | sending_date |
| a | recipients_first_names |
| b | recipients_last_names |
| c | sms_fields_1 |
| d | sms_fields_2 |
| e | sms_fields_3 |
| W | with_replies |
| N | transactional |
| Q | request_id |