Estadísticas
Estadísticas de datos de entrega (por día)
Datos de SMS contabilizados por día
URL
https://sms.api.engagelab.cc/v1/stats_day
https://sms.api.engagelab.cc/v1/stats_day
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | string | sí | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| time_zone | string | no | zona horaria, ejemplo: +8 |
| template_ids | string | no | varios ID de plantilla; separados por ; por ejemplo: template_ids=1; 2; 3. Se admiten hasta 10 |
| sms_users | string | no | obtener datos estadísticos de un SMS_USER específico; varios SMS_USER separados por ;, por ejemplo: sms_users=a; b; c. Se admiten hasta 10 |
| label_ids | string | no | lista de ID de etiquetas de SMS; separados por ;, por ejemplo: label_ids=123456; 456789. Se admiten hasta 10 |
| start_date | string | sí | start_date, con formato yyyy-MM-dd |
| end_date | string | sí | end_date, con formato yyyy-MM-dd |
| msg_type | string | no | tipo de SMS; 2 representa SMS internacional |
| aggregate_by | string | no | el valor predeterminado es 0; si aggregate=1, se devolverán datos agregados |
Nota:
- El número de días a consultar no debe superar los 90 días.
- Cuando 'aggregate_by' es 1, la agregación de datos se realizará según 'msg_type'; cuando 'aggregate_by' es 0, no se realiza agregación de datos
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| send_date | fecha de envío |
| msg_type | tipo de SMS |
| sms_user | SMS_USER |
| template_id | ID de la plantilla de SMS |
| label_id | ID de etiqueta |
| targets | total de destinos, números solicitados |
| sent | total enviados |
| process_failed | número de fallos de procesamiento |
| delivered | número de entregados |
| send_failed | número de fallos de envío |
| wait_result | número en espera de resultado |
| billing_count | recuento de facturación |
| process_failed_percent | porcentaje de fallos de procesamiento |
| delivered_percent | porcentaje de entregados |
| send_failed_percent | porcentaje de fallos de envío |
| wait_result_percent | porcentaje en espera de resultado |
Ejemplo de valor devuelto
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-27",
"msg_type" : "2",
"sms_user" : "sms_user",
"template_id" : 11,
"label_id" : 110,
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0,
"send_failed_percent" : 0,
"wait_result_percent" : 0
}
],
count:1
}
Este bloque de código se muestra en una ventana flotante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
}
{
"result" : {
"msg_type" : "2",
"targets" : 1,
"sent" : 0,
"process_failed" : 0,
"delivered" : 1,
"send_failed" : 0,
"wait_result" : 0,
"billing_count" : 2,
"process_failed_percent" : 0.0,
"delivered_percent" : 0.0,
"send_failed_percent" : 0.0,
"wait_result_percent" : 0.0
}
}
}
Este bloque de código se muestra en una ventana flotante
Fallo de procesamiento
Estadísticas de clasificación para fallos de procesamiento de consultas
URL
https://sms.api.engagelab.cc/v1/stats/process_failed
https://sms.api.engagelab.cc/v1/stats/process_failed
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | sí | Basic base64(smsUser:smsKey) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| time_zone | string | no | zona horaria, ejemplo: +8 |
| sms_users | string | no | obtener datos estadísticos de un SMS_USER específico; varios SMS_USER separados por ;, por ejemplo: sms_users=a; b; c. Se admiten hasta 10 |
| start_date | string | sí | start_date, con formato yyyy-MM-dd |
| end_date | string | sí | end_date, con formato yyyy-MM-dd |
| msg_type | string | no | tipo de SMS; 2 representa SMS internacional |
| label_ids | string | no | lista de ID de etiquetas de SMS; separados por ;, por ejemplo: label_ids=123456; 456789. Se admiten hasta 10 |
| template_ids | string | no | varios ID de plantilla; separados por ;, por ejemplo: template_ids=1; 2; 3. Se admiten hasta 10 |
| aggregate_by | string | no | el valor predeterminado es 0; si aggregate=1, se devolverán datos agregados |
Nota:
- El número de días a consultar no debe superar los 90 días.
- Cuando 'aggregate_by' es 1, la agregación de datos se realizará según 'msg_type'; cuando 'aggregate_by' es 0, no se realiza agregación de datos
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| send_date | fecha de envío |
| label_id | ID de etiqueta |
| msg_type | tipo de SMS |
| sms_user | SMS_USER |
| template_id | ID de la plantilla de SMS |
| global_block | número de bloqueos globales |
| partial_block | número de bloqueos parciales |
| unsubscribe | número de cancelaciones de suscripción |
| keyword_block | número de bloqueos por palabra clave |
| variable_error | número de errores de variable |
| content_error | número de errores de contenido |
| frequency_overrun | número de excesos de frecuencia |
| other | número de otros |
Ejemplo de valor devuelto
aggregate_by=0
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
{
"result" : [{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 122,
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
],
count:1
}
Este bloque de código se muestra en una ventana flotante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
{
"result" : {
"msg_type" : "2",
"global_block": 133
"partial_block" : 0,
"unsubscribe" : 0,
"keyword_block" : 0,
"variable_error" : 0,
"content_error" : 0,
"frequency_overrun" : 0,
"other" : 0
}
}
Este bloque de código se muestra en una ventana flotante
Fallo de envío
Estadísticas de clasificación de fallos de envío
URL
https://sms.api.engagelab.cc/v1/stats/send_failed
https://sms.api.engagelab.cc/v1/stats/send_failed
Este bloque de código se muestra en una ventana flotante
Método de solicitud HTTP
GET
GET
Este bloque de código se muestra en una ventana flotante
Encabezados de la solicitud
| Encabezado | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| Authorization | String | sí | Basic base64(sms_user:sms_key) |
Descripción de parámetros
| Parámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| time_zone | string | no | zona horaria, ejemplo: +8 |
| sms_users | string | no | obtener datos estadísticos de un SMS_USER específico; varios SMS_USER separados por ;, por ejemplo: sms_users=a; b; c. Se admiten hasta 10 |
| start_date | string | sí | start_date, con formato yyyy-MM-dd |
| end_date | string | sí | end_date, con formato yyyy-MM-dd |
| msg_type | string | no | tipo de SMS; 2 representa SMS internacional |
| label_ids | string | no | lista de ID de etiquetas de SMS; separados por ;, por ejemplo: label_ids=123456; 456789. Se admiten hasta 10 |
| template_ids | string | no | varios ID de plantilla; separados por ;, por ejemplo: template_ids=1; 2; 3. Se admiten hasta 10 |
| aggregate_by | string | no | el valor predeterminado es 0; si aggregate=1, se devolverán datos agregados |
Consejos:
- El número de días a consultar no debe superar los 90 días.
- Cuando 'aggregate_by' es 1, la agregación de datos se realizará según 'msg_type'; cuando 'aggregate_by' es 0, no se realiza agregación de datos
Ejemplo de solicitud
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
Este bloque de código se muestra en una ventana flotante
Descripción del valor devuelto
| Parámetro | Descripción |
|---|---|
| send_date | fecha de envío |
| label_id | ID de etiqueta |
| msg_type | tipo de SMS |
| sms_user | SMS_USER |
| template_id | ID de la plantilla de SMS |
| empty | número de vacíos |
| out_of_service | número de fuera de servicio |
| blacklist | número de lista negra |
| busy | número de ocupados |
| no_answer | número de sin respuesta |
| interception | número de interceptaciones |
| break_down | número de averías |
| not_in_service | número de no está en servicio |
| power_off | número de apagados |
| other | otros |
Ejemplo de valor devuelto
aggregate_by=0
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
}
{
"result" : [
{
"send_date" : "2016-09-09",
"label_id" : 110,
"msg_type" : "2",
"sms_user":"sms",
"template_id" : 10,
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
],
"count":1
}
}
Este bloque de código se muestra en una ventana flotante
aggregate_by=1
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
{
"result" : {
"msg_type" : "2",
"empty" : 0,
"out_of_service" : 3,
"blacklist" : 0,
"busy" : 0,
"no_answer" : 0,
"interception" : 0,
"break_down" : 0,
"not_in_service" : 0,
"power_off" : 0,
"other" : 2
}
}
Este bloque de código se muestra en una ventana flotante
