MasivEssentials| sms

Autenticación

Todas las peticiones al REST API requieren autenticación Basic. Puedes ver varios ejemplos utilizando diferentes lenguajes de programación en la sección Envía tu primer mensaje.

Nota: Recuerda que tu usuario es el correo electrónico con el que te registraste y la contraseña se encuentra en el menú de Configuración (es diferente a la contraseña que utilizas para ingresar al sistema).

Formato

Utilizamos JSON para las peticiones y las respuestas. JSON es un formato de intercambio de información muy ligero que es fácil de escribir y leer tanto para humanos como para máquinas. JSON es más compacto que XML, más rápido de analizar y más fácil de interpretar.

Existen librerías JSON para prácticamente todos los lenguajes de programación. Puedes encontrar el listado completo al final de esta página.

Códigos de Respuesta

Los siguientes son posibles códigos de respuesta HTTP/S que puede generar el sistema:

HTTP POST - Enviar/Programar Mensaje

Para enviar un mensaje a uno o más celulares debes hacer un HTTP/S POST al siguiente URL:

https://www.elibom.com/messages

Parámetros

Los parámetros que debes especificar en el POST para enviar un mensaje son los siguientes:

{ 
    "to": "573002111111,583242111111",
    "text": "Esto es una prueba",
    "scheduleDate": "2014-02-18 19:10"
}

Respuesta

Si el envío es inmediato (sin el parámetro scheduleDate) y la petición es correcta, se recibirá un deliveryToken:

{ "deliveryToken": "1-2347558688" }

Si el envío es programado y la petición es correcta, se recibrá un scheduleId:

{ "scheduleId": "2376" }

Puedes ver varios ejemplos en diferentes lenguajes de programación consultando la sección Envía tu primer mensaje.

HTTP GET - Consultar Envío

Para consultar un envío específico, debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/messages/{deliveryToken}

Donde {deliveryToken} es el valor retornado en el HTTP/S POST al enviar un mensaje.

Ejemplo de Respuesta

{
    "deliveryId": "1-2347558688",
    "numSent": 1,
    "numFailed": 0,
    "status": "finished",
    "messages": [{
        "id": 747465,
        "user": {
            "id": 2455,
            "url": "https://www.elibom.com/users/2455"
        },
        "to": "573132111111",
        "operator": "Claro (Colombia)",
        "text": "Esto es una prueba",
        "status": "sent",
        "statusDetail": "sent",
        "credits": 1.8,
        "from": "2222",
        "createdAt": "2013-06-24 10:13:00",
        "sentAt": "2013-06-24 10:13:00"
    }]
}

Los posibles valores para status del envío (delivery) son:

Los posibles valores para status del mensaje son:

Los posibles valores para statusDetail son:

HTTP GET - Consultar Envíos Programados

Para consultar los envíos que están programados debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/schedules/scheduled

Ejemplo de Respuesta

[
    { 
      "id": 34,
      "user": { "id": 45, "url": "https://www.elibom.com/users/45" },
      "scheduledTime": "2013-05-23 10:23:00",
      "creationTime": "2012-09-23 22:00:00",
      "isFile": true,
      "fileName": "test.xls",
      "fileHasText": false,
      "text": "Esto es una prueba" 
    },
    { 
      "id": 35,
      "user": { "id": 45, "url": "https://www.elibom.com/users/45" },
      "scheduledTime": "2013-05-23 10:23:00",
      "creationTime": "2012-09-23 22:00:00",
      "isFile": false,
      "destinations": "573002111111",
      "text": "Esto es una prueba"
    }
]

Nota: si el campo isFile es true, recibirás los campos fileName y fileHasText en vez del campo destinations.

HTTP GET - Consultar Envío Programado

Para consultar un envío programado debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/schedules/{id}

Donde {id} es el id del envío programado que deseas consultar.

Ejemplo de Respuesta

{ 
      "id": 34,
      "user": { "id": 45, "url": "https://www.elibom.com/users/45" },
      "scheduledTime": "2013-05-23 10:23:00",
      "creationTime": "2012-09-23 22:00:00",
      "status": "scheduled",
      "isFile": true,
      "fileName": "test.xls",
      "fileHasText": false,
      "text": "Esto es una prueba" 
}

Nota: si el campo isFile es true, recibirás los campos fileName y fileHasText en vez del campo destinations.

Los posibles valores para status son:

HTTP DELETE - Cancelar Envío Programado

Para cancelar un envío programado debes hacer un llamado DELETE al siguiente URL:

https://www.elibom.com/schedules/{id}

Donde {id} es el id del envío programado que deseas cancelar.

Este llamado no devuleve ninguna respuesta en el cuerpo. Si el envío programado fue cancelado correctamente recibirás un status 200 OK. Si el envío no existe recibirás un 404 NOT FOUND. Si el envío ya fue ejecutado recibirás un status 409 CONFLICT.

HTTP GET - Consultar Cuenta

Para consultar la información de tu cuenta debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/account

Ejemplo de Respuesta

{
    "name": "Nombre de la cuenta",
    "credits", 10.0,
    "owner": {
        "id": 2455,
        "url": "https://www.elibom.com/users/2455"
    }
}

HTTP GET - Consultar Usuarios

Para consultar la información de los usuarios registrados en tu cuenta debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/users

Ejemplo de Respuesta

[
    {
        "id": 222,
        "name": "Usuario 1",
        "email": "usuario1@tudominio.com",
        "status": "active"
    },
    {
        "id": 223,
        "name": "Usuario 2",
        "email": "usuario2@tudominio.com",
        "status": "invited"
    }
]

Los posibles valores para status son:

HTTP GET - Consultar Usuario

Para consultar la información de un usuario registrado en tu cuenta debes hacer un llamado GET al siguiente URL:

https://www.elibom.com/users/{id}

Donde {id} es el id del usuario que deseas consultar.

Ejemplo de Respuesta

{
    "id": 222,
    "name": "Usuario 1",
    "email": "usuario1@tudominio.com",
    "status": "active"
}

Los posibles valores para status son: