Documentación API-SMS: SMS Transaccionales

Definición

Esta opción es para mensajes NO COMERCIALES.

Ejemplos:

Confirmaciones de registro, pago, control de envío, envío de alertas, recordatorios de citas, etc.

Con esta opción, puede enviar sus mensajes 24/7.

ADVERTENCIA: Cualquier error o fraude cometido al enviar mensajes publicitarios con la opción de «SMS transaccional» resultará en multas como se describe en los Términos y Condiciones.
Utilice esta opción con precaución.

URL

POST

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

Codificación: UTF-8

Parametros Especiales

Nombre	Tipo	Descripción
text	string	Texto del mensaje (de 1 a 1224 caractéres no unicode).
recipients	array	Lista de objetos Contacto (array de objetos) : [ { "phone_number": "+111222233334444", "first_name": "Axelle", "last_name": "Durand", "param1": null, "param2": null, "param3": Sra., "param4": null, "param5": null }, ..., { "phone_number": "+2222333334444555", "first_name": "John", "last_name": "Smith", "param3": "Sr." } ]
sender	string	Quien envía el mensaje (si el operador lo permite), 3-11 caractéres alfanuméricos y espacios (a-zA-Z0-9 ).
send_at	string	(opcional) Fecha en la cual se envía la campaña. Formato: DateTime ISO8601 (par ex: “2018-10-03T07:42:39-07:00”).’
purpose	string	(opcional) Propósito de la campaña (transactionnel/alerte ou marketing) : [“wholesale” (default), “alert”]
with_replies	boolean	(opcional) “True” para recibir respuestas de los destinatarios
simulation_mode	boolean	(opcional) Si este campo está en “true”, su solicitud será simulada y recibirá resultados ficticios. Solamente algunas validaciones será efectuadas.
request_id	string	(opcional) Para evitar enviar la misma solicitud varias veces, configúre un ID de solicitud. En caso de que la duplicación se detecte, un error de validación será renviado.
auto_optimize_text	boolean	(opcional) Si este campo se transmite y tiene un valor falso, su texto no será optimizado por el robot de Octopush (su mensaje podría contenenr caractéres unicode o espacios inútiles que podrían aumentar el número de SMS necesarios para cada uno de dus contactos).

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": "+336000123"}],
  "text": "He aquí un SMS Premium con la mención STOP. STOP al 30101",
  "type": "sms_premium",
  "purpose": "alert",
  "sender": "Compañía X"
}'

Respuesta JSON

Éxito : 201 CREATED

{
  "sms_ticket": "sms_5f3fbce61266e",
  "number_of_contacts": 1,
  "number_of_sms_needed": 1,
  "residual_credit": 94.995,
  "total_cost": 5.00502839 
}

Fallido : 400 BAD REQUEST

{
  "code": 121,
  "message": "Mention STOP is missing."
}

* Para algunos usuarios OVH, la utilisación de curl_setopt($ch, CURLOPT_FRESH_CONNECT, true); en su sequencia de envío CURL podría resultar útil.

Menu

SMS Transaccionales