Documentación de la API

Introducción

La API de EnvíaTuSMS permite a los desarrolladores el envío programático de mensajes de texto (SMS) de forma individual y masiva haciendo uso de su balance de créditos. Las peticiones pueden realizarse de forma secuencial o asíncrona según sea el requerimiento.

Las peticiones realizadas a la API podrán realizarse utilizando la librería cURL con el lenguaje de programación de su preferencia.
Las peticiones GET reciben los parametros en la URL.
Las peticiones POST reciben los parametos codificados en JSON con un header Content-Type: application/json.
Las respuestas retornadas por la API serán en formato JSON.

Una petición exitosa retornará un estatus HTTP de 200 OK.

API URL

URL principal para todas las peticiones.

https://www.enviatusms.com/api

Autenticación

Todas las peticiones deberán estar acompañadas de su api_key como parámetro GET en la URL, la cual puede verificar accediendo desde su cuenta aquí.

Ejemplo de petición con autenticación

https://www.enviatusms.com/api/balance?api_key=MI_API_KEY

Endpoints

Obtener balance de créditos

Un (1) crédito equivale a un (1) SMS enviado a través de la API. Le recomendamos siempre consultar su balance antes de envíar una campaña de mensajería para ahorrarse peticiones fallidas.

HTTP Request

GET /balance

Ejemplo de request:

curl https://www.enviatusms.com/api/balance?api_key=MI_API_KEY

Parámetros retornados

Parámetro	Tipo	Descripción
`status`	string	`ok` al obtener una respuesta válida o `error` cuando haya un problema
`creditos`	integer	Cantidad de créditos disponibles

Ejemplo de response JSON:


                                {
                                "status":"ok",
                                "creditos":1500
                                }

Enviar mensaje de texto (SMS)

Los mensajes de texto enviados a través de la API serán programados para su envío de forma inmediata y se descontarán automáticamente de su balance de usuario.

HTTP Request

POST /sms-multi

Parámetros disponibles

Parámetro	Tipo	Descripción
`numeros`	array	Un array de números en formato local o internacional hacia donde va dirigido el mensaje de texto. Un formato de número valido puede ser con código de area: `584241234567` o sin dicho código: `4241234567`
`texto`	string	Texto del mensaje a enviar. Máximo 160 caracteres. Caracteres que no sean `ASCII` serán convertidos a su equivalente antes de envíar el SMS. Estos caracteres pueden ser por ejemplo letras con acentos `á`, `é`, `í`, `ó`, `ú`

Ejemplo de request:

curl -X POST -H "Content-Type: application/json" -d '{"numeros":["04265461179", "04244623824"], "texto":"Mensaje de prueba"}' https://www.enviatusms.com/api/sms-multi?api_key=MI_API_KEY

Parámetros retornados

Parámetro	Tipo	Descripción
`status`	string	`ok` al obtener una respuesta válida o `error` cuando haya un problema
`msg`	string	Información adicional de la respuesta obtenida
`ignored`	array	Un `array` de números de celular que no cumplan con el formato de número de celular correcto. Los números ignorados no serán descontados de su balance.

Ejemplo de response JSON:


                                {
                                "status":"ok",
                                "msg":"Mensaje enviado con exito. Numeros invalidos ignorados.",
                                "ignored": ["581234567896", "58123456789"]
                                }