Comprobar el estado de los envíos

La plataforma de Descom SMS, ofrece notificaciones de entrega. Estás se producen asincronamente. Desde está sección puede comporbar el estado de entrega de los mensajes de un envío. Para ello debe realizar una llamada de tipo GET a la siguiente URL: https://api.descomsms.com/api/shipment/{id}

El parámetro {id}, debemos de sustituirlo por el identificativo del envío que obtuvimos en la respuesta de un envío de SMS, que puede ver en el aparatado anterior.

Ejemplo


    curl https://api.descomsms.com/api/shipment/100 \
    -H "Content-Type: application/json" \
    -H "DSMS-User: poner_aqui_el_usuario" \
    -H "DSMS-Pass: poner_aqui_el_password"

Respuestas esperadas


  • 200 La petición se ha efectuado correctamente
  • 401 Autentificación requerida o denegada
  • 403 No tiene permisos para acceder a este elemento
  • 503 Error interno, la petición no ha sido efectuada

En el caso que la respuesta sea correcta, obtendrá en el contenido de la misma un json con el resultado del envío. Definimos a continuación en una tabla los parametros que obtendremos en la respuesta:

ParámetroTipoDescripción
id Integer Identificativo del envío, podremos usarlo para comprobar posteriormente el estado de entrega de los mensajes.
dryrun Boolean Será `true` si el envío fue simulado
num_messages Integer Número totales de mensajes en el envío
num_sms Integer Número totales de SMS que se envió
cost_credits Double Créditos que nos desconto en la cuenta el envío
credits_before Double Créditos que disponía la cuenta antes del envío
credits_after Double Créditos que disponía la cuenta después del envío
ip String Dirección IP desde donde se lanzó el envío
created_at DateTime Fecha en la que se realizó la petición
updated_at DateTime Fecha en la que se modifico por última vez el envío
status Object Status Devuelve un objeto con el número de mensajes en cada estado posible

Definición: Object Status

ParámetroTipoDescripción
sending Integer Número de mensajes encolado en nuestra plataforma, pendientes de enviar.
sent Integer Número de mensajes enviado a ruta desde nuestra plataforma.
receive_by_smsc Integer Número de mensajes con confirmación de entrega a la operadora.
receive_by_destination Integer Número de mensajes con confirmación de entrega al destinatario.

Ejemplo de respuesta:

{
    "id": 390,
    "dryrun": true,
    "num_messages": 1,
    "num_sms": 1,
    "cost_credits": 1,
    "credits_before": 678.2,
    "credits_after": 678.2,
    "ip": "127.0.0.1",
    "created_at": {
        "date": "2017-09-08 10:08:34.000000",
        "timezone_type": 3,
        "timezone": "Europe/Madrid"
    },
    "updated_at": {
        "date": "2017-09-08 10:08:34.000000",
        "timezone_type": 3,
        "timezone": "Europe/Madrid"
    },
    "status": {
        "sending": 1,
        "sent": 0,
        "receive_by_smsc": 0,
        "receive_by_destination": 0,
        "error": 0
    }
}