Inicio » API SMS Octopush » SMS con respuesta (SMS 2-vías)

SMS con respuesta (SMS 2-vías)

Codificación : UTF-8

Autentificación

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

Definición

Al enviar a Francia continental (puede consultar sobre otros destinos), puede activar la opción «Respuesta de SMS».
El remitente se reemplaza por un número corto, sin cargo, al que sus destinatarios pueden responder.

Recibiendo Respuestas

3 formas de obtener las respuestas:

  • En la interfaz: tiene acceso a sus respuestas por país o por fecha.
  • Correo electrónico: envíenos un correo electrónico al que responderemos con las respuestas tan pronto como lleguen.
  • Callback: envíenos una URL que podamos usar para enviarle las respuestas. > Read more

Parametros Especiales

NombreTipoDescripción
textstringTexto del mensaje (de 1 a 1224 caractéres no unicode).
recipientsarrayLista 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."
  }
]
typestringTipo de campaña : [“sms_premium”,”sms_low_cost”]
senderstringQuien envía el mensaje (si el operador lo permite), 3-11 caractéres alfanuméricos y espacios (a-zA-Z0-9 ).
send_atstringFecha en la cual se envía la campaña. Formato: DateTime ISO8601 (par ex: “2018-10-03T07:42:39-07:00”).’
purposestringPropósito de la campaña (transactionnel/alerte ou marketing) : [“alert”,”wholesale”]
with_repliesboolean“True” para recibir respuestas de los destinatarios
simulation_modeboolean(opcional) Si este campo está en “true”, su solicitud será simulada y recibirá resultados ficticios. Solamente algunas validaciones será efectuadas.
request_idstring(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_textboolean(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",
      "first_name": "Axelle",
      "last_name": "Durand",
      "param3": "Sra"
    }
  ],
  "text": "He aquí un SMS Premium con la mención STOP. STOP al 30101",
  "type": "sms_premium",
  "purpose": "wholesale",
  "sender": "12345",
  "with_replies": true
}'

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.