POST
https://api.octopush.com/v1/public/sms-campaign/sendCodificación : UTF-8
Autentificación
Su “api-key” y “api-login” deben ser añadidos en las cabeceras.
Definición
Es el mismo servicio que el envío de un SMS simple, pero puede especificar una fecha de envío en formato ISO.
En cuanto pase la fecha que ha especificado, enviaremos su SMS.
Parámetros especiales
| Nombre | Tipo | Descripción |
|---|---|---|
| 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"
},
...,
{
"phone_number": "+2222333334444555",
"param1": "John",
}
] |
| type | string | Tipo de la campaña: [“sms_premium”,”sms_low_cost”] |
| sender | string | Emisor del mensaje (si el usuario lo permite), 3-11 caracteres alfanuméricos (a-zA-Z0-9). |
| send_at | string | ‘Cuando quieras enviar la campaña de sms. Formato: DateTime ISO8601 (ej: “2018-10-03T07:42:39-07:00”).’ |
| purpose | string | Propósito de la campaña: (transaccional/alerta o marketing) : [“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. El request_id expira luego de 24 horas. |
| auto_optimize_text | boolean | (opcional) Transmitiendo este campo con valor “falso”, su texto no será optimizado por el robot Octopush (su mensaje podría contener caracteres unicode, o espacios inútiles que podrían aumentar el número de SMS necesarios para cada contacto). |
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": "+34932200520",
"param1": "Antonio"
}
],
"text": "Es un SMS Premium con mención de desuscripción. STOP al XXXXX",
"type": "sms_premium",
"purpose": "wholesale",
"sender": "Empresa X",
"send_at": "2025-07-29T11:00:39-07:00"
}'Respuesta Servidor en JSON
Éxito : 201 CREATED
{
"sms_ticket": "sms_5f3fbce61266e",
"number_of_contacts": 1,
"total_cost": 5.00502839
}Error : 400 Bad Request
{
"code": 121,
"message": "Falta la mención STOP."
}Para algunos usuarios de ovh, el uso de curl_setopt($ch, CURLOPT_FRESH_CONNECT, true); en su secuencia de envío de Curl puede ser útil.