Para enviar un mensaje SMS a través de la API Envío de mensajes, deberá realizar una petición del siguiente "endpoint":
POST https://app.smsclick.com.mx/sms-services/sendMsg.json| Parámetro | Descripción |
|---|---|
| APIKEY | Obligatorio Clave generada en la sección API KEY de este manual. |
| TELEFONO | Obligatorio Número de celular del destinatario a 10 dígitos ejemplo: 5551402211 |
| MENSAJE | Obligatorio Mensaje que desea enviar. |
| ID_REGLA_INTERACTIVA | OpcionalIdentificador de regla interactiva que se aplicará al mensaje |
| Parámetro | Descripción | Observaciones |
|---|---|---|
| codigo | Código de respuesta | 1=Mensaje enviado, Cualquier otro valor es un error al enviar mensaje. Ver lista de posibles errores en ejemplos. |
| descripcion | Descripción del código de respuesta. | N/A |
| id_mensaje | Identificador del mensaje enviado | N/A |
| creditos_usados | Cantidad de créditos usados en este mensaje | Este valor depende del número de caracteres enviados por mensaje.(Después de 150 caracteres se cobrarán créditos adicionales dependiendo el tamaño) |
| {"codigo":1, "descripcion":"Mensaje enviado", "id_mensaje":123, "creditosUsados":1} |
| {"codigo": -100, "descripcion":"Parámetro APIKEY no definido"} |
| {"codigo": -101, "descripcion":"APIKEY incorrecta"} |
| {"codigo": -102, "descripcion":"Parametro TELEFONO no valido"} |
| {"codigo": -103, "descripcion":"Parametro MENSAJE vacio"} |
| {"codigo": -104, "descripcion":"Saldo insuficiente"} |
| {"codigo": -105, "descripcion":"El valor ID_REGLA_INTERACTIVA no existe"} |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://app.smsclick.com.mx/sms-services/sendMsg.json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
"APIKEY=1EgdzRnSFX83mPh2WK7yTIyJTUZPVmA6puXwU4GK&TELEFONO=5526632636&MENSAJE=Prueba de envio desde la API");
// receive server response ...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
curl_close ($ch);
// further processing ....
echo 'RESPONSE:' . $server_output;
print "\n";
Este método proporciona el estatus actual de cada mensaje enviado. A través de este servicio podrá saber el estatus en el que se encuentra cada mensaje enviado
La URL del "endpoint" es la siguiente:
POST https://app.smsclick.com.mx/sms-services/getMsg.json| Parámetro | Descripción |
|---|---|
| APIKEY | Obligatorio Clave generada en la sección API KEY de este manual. |
| ID_MENSAJE | Obligatorio Identificador del mensaje a consultar. |
| Parámetro | Descripción | Observaciones |
|---|---|---|
| codigo | Código de respuesta | 1=Mensaje enviado, Cualquier otro valor es un error al enviar mensaje. Ver lista de posibles errores en ejemplos. |
| descripcion | Descripción del código de respuesta. | N/A |
| estatus_mensaje | Código de estatus del mensaje | Consiste en un número que corresponde al estatus que fue devuelto por el envío de tu mensaje. Los estatus pueden ser:
|
| telefono | Número de celular al que se envió el mensaje | N/A |
| mensaje | Mensaje enviado | N/A |
| fecha_envio | Fecha de envío del mensaje | Fecha en formato DD-MM-AAAA HH:mm:ss |
| respuesta | Mensaje de respuesta del cliente | Aplica solamente cuando sea un mensaje un mensaje interactivo de lo contrario viene con valor "NULL" |
| fecha_respuesta | Fecha en que el cliente respondió al mensaje | Fecha de espuesta del cliente en formato DD-MM-AAAA HH:mm:ss, aplica solo para mensajes interactivos |
| {"codigo":1, "descripcion":"ok", "estatus_mensaje":1, "telefono":5554542570, "mensaje":"Felicidades: Responde SI para usar tus puntos en tu compra", "fecha_envio":"12-08-2017 17:34:56", "respuesta":"Si", "fecha_respuesta":"12-08-2017 17:40:41"} |
| {"codigo":-100, "descripcion":"Apikey no definida", "estatus_mensaje":null, "fecha_recepcion":null, "respuesta":null} |
| {"codigo":-101, "descripcion":"Apikey incorrecta", "estatus_mensaje":null, "fecha_recepcion":null, "respuesta":null} |
| {"codigo":-200, "descripcion":"Identificador de mensaje no válido", "estatus_mensaje":null, "fecha_recepcion":null, "respuesta":null} |
| {"codigo":-201, "descripcion":"Identificador de mensaje no existe", "estatus_mensaje":null, "fecha_recepcion":null, "respuesta":null} |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://app.smsclick.com.mx/sms-services/getMsg.json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
"APIKEY=1EgdzRnSFX83mPh2WK7yTIyJTUZPVmA6puXwU4GK&ID_MENSAJE=455121");
// receive server response ...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
curl_close ($ch);
// further processing ....
echo 'RESPONSE:' . $server_output;
print "\n";
El API Reporte sirve para consultar la información de sus mensajes enviados en un rango de fechas específico.
Para ver su reporte a través de la API Reporte, deberá realizar una petición al siguiente "endpoint":
POST https://app.smsclick.com.mx/sms-services/report.json| Parámetro | Descripción |
|---|---|
| APIKEY | Obligatorio Clave generada en la sección API KEY de este manual. |
| FECHA_INICIO | Obligatorio Fecha de inicio de su reporte en formato DD-MM-AAAA HH:mm:ss. Ejemplo: 20-01-2018 00:00:00 |
| FECHA_FIN | Obligatorio Fecha fin de su reporte en formato DD-MM-AAAA HH:mm:ss. Ejemplo: 30-03-2018 23:59:59 |
| ESTATUS_MENSAJE | Opcional Filtro para uno o varios estatus separados por comas. Por ejemplo:2,3,4. |
| ID_CAMPANIA | Opcional Filtrar por Identificador de campaña. |
| Parámetro | Descripción | Observaciones |
|---|---|---|
| codigo | Código de respuesta | 1=Mensaje enviado, Cualquier otro valor es un error al enviar mensaje. Ver lista de posibles errores en ejemplos. |
| descripcion | Descripción del código de respuesta. | N/A |
| mensajes | Array con la lista de registros obtenidos del reporte. | N/A |
| id_mensaje | Identificador del mensaje | N/A |
| telefono | Número de celular al que se envió el mensaje | N/A |
| mensaje | Mensaje enviado | N/A |
| fecha_envio | Fecha de envío del mensaje | Fecha en formato DD-MM-AAAA HH:mm:ss |
| estatus_mensaje | Código de estatus del mensaje | Consiste en un número que corresponde al estatus que fue devuelto por el envío de tu mensaje. Los estatus pueden ser:
|
| nombre_campania | Nombre de la campaña en la cual se envió el mensaje | Solo si aplica |
| portafolio | Nombre del portafolio en el que se envió el mensaje | Solo si aplica | fecha_respuesta | Fecha del mensaje de respuesta del cliente | Fecha de espuesta del cliente en formato DD-MM-AAAA HH:mm:ss, aplica solo para mensajes interactivos |
| respuesta_cliente | Mensaje de respuesta del cliente | Aplica solo para mensajes interactivos |
| "{""codigo"":1,""descripcion"":""ok"",""mensajes"":[ { ""id_mensaje"":123456, ""telefono"":5548007276, ""mensaje"":""MERCADOLIBRE: Responda SI para utilizar su puntos premia en su compra de $1,500"", ""fecha_envio"":""12-08-2017 13:35:56"", ""estatus_mensaje"":1, ""nombre_campania"":""CAMPAÑA MERCADO LIBRE 2017"", ""portafolio"":""TARJETAHABIENTES BANAMEX"", ""fecha_respuesta"":""13-08-2017 15:35:56"", ""respuesta_cliente"":""SI"" } ]}" |
| {"codigo":-100, "descripcion":"Apikey no definida", "mensajes":null} |
| {"codigo":-101, "descripcion":"Apikey incorrecta", "mensajes":null} |
| {"codigo":-300, "descripcion":"Parametro FECHA_INICIO vacío o formato incorrecto", "mensajes":null} |
| {"codigo":-301, "descripcion":"Parametro FECHA_FIN vacío formato incorrecto", "mensajes":null} |
| {"codigo":-302, "descripcion":"Parametro ESTATUS_MENSAJE formato incorrecto", "mensajes":null} |
| {"codigo":-303, "descripcion":"Parametro ID_CAMPANIA formato incorrecto", "mensajes":null} |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://app.smsclick.com.mx/sms-services/report.json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
"APIKEY=1EgdzRnSFX83mPh2WK7yTIyJTUZPVmA6puXwU4GK&FECHA_INICIO=01-01-2018 00:00:00&FECHA_FIN=30-03-2018 23:59:59");
// receive server response ...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
curl_close ($ch);
// further processing ....
echo 'RESPONSE:' . $server_output;
print "\n";
La API Crédito sirve para consultar tu crédito actual.
Las peticiones se deben de realizar a través del siguiente "endpoint":
POST https://app.smsclick.com.mx/sms-services/credits.json| Parámetro | Descripción |
|---|---|
| APIKEY | Obligatorio Clave generada en la sección API KEY de este manual. |
| Parámetro | Descripción | Observaciones |
|---|---|---|
| codigo | Código de respuesta | 1=Mensaje enviado, Cualquier otro valor es un error al enviar mensaje. Ver lista de posibles errores en ejemplos. |
| descripcion | Descripción del código de respuesta. | N/A |
| creditos | Cantidad de créditos disponibles | N/A |
| {"codigo":1, "descripcion":"ok", "creditos":1200232} |
| {"codigo":-100, "descripcion":"Apikey no definida", "mensajes":null} |
| {"codigo":-101, "descripcion":"Apikey incorrecta", "mensajes":null} |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL,"https://app.smsclick.com.mx/sms-services/credits.json");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
"APIKEY=1EgdzRnSFX83mPh2WK7yTIyJTUZPVmA6puXwU4GK");
// receive server response ...
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
curl_close ($ch);
// further processing ....
echo 'RESPONSE:' . $server_output;
print "\n";
