Skip to content
Inicio » API SMS Octopush » API SMS » Estados SMS en una lista

Estados SMS en una lista

GET
https://api.octopush.com/v1/public/sms-campaign-on-list/status

Codificación : UTF-8

Autentificación

Su “api-key” y “api-login” deben ser añadidos en las cabeceras.

Definición

Este servicio permite obtener el estado de una campaña de mensajes de texto en una lista. Este servicio web sólo es útil si su campaña, creada a través del servicio
https://api.octopush.com/v1/public/sms-campaign-on-list/create, se está calculando y aún no se ha enviado.

Parámetros especiales

CampoTipoDescripción
ticket_numberstringEste es el ticket_number transmitido por Octopush luego de llamar a la función de creación

Ejemplo Curl

curl -X GET \ 
'https://api.octopush.com/v1/public/sms-campaign-on-list/status?ticket_number=sms_xxxX0000xxxxx0000' \ 
-H 'api-key: ************' \ 
-H 'api-login: ******@email.org' \ 
-H 'cache-control: no-cache'

Respuesta Servidor en JSON

Éxito : 201 CREATED

{
  "number_of_contacts": 20,
  "cost": 2.58,
  "status": "ready_to_be_send"
}

Error : 400 Bad Request

Este error se devolverá mientras la campaña no esté lista.

Valores posibles para el campo “estado”

  • ready_to_be_sent
  • under_computation
  • failed