简体中文
English
繁體中文
简体中文
にほんご
ภาษาไทย
登录 注册
icon AppPush icon WebPush icon WhatsApp icon Email icon SMS icon OTP
EngageLab 文档 > SMS > REST API > 发信数据
EngageLab 文档 > SMS > REST API > 发信数据

发信数据

最新更新：2023-04-10

发送数据统计（每天）

按天统计的短信数据

URL

https://sms.api.engagelab.cc/v1/stats_day
          https://sms.api.engagelab.cc/v1/stats_day
此代码块在浮窗中显示

HTTP请求方式

GET
          GET
此代码块在浮窗中显示

Request-Headers

Header 类型 必须 说明
Authorization string true Basic base64(sms_user:sms_key)

参数说明

参数 类型 必须 说明
time_zone string 否 时区。默认时区：+8
template_ids string 否 多个模板ID，用；分开, 如：template_ids=1;2;3 ，最大支持10个
sms_users string 否 获取指定 SMS_USER 的统计数据, 多个 SMS_USER 用;分开, 如：sms_users=a;b;c ，最大支持10个
label_ids string 否 短信标签ID列表，用;分开，如label_ids=123456;456789 ，最大支持10个
start_date string 是 开始日期，格式为 yyyy-MM-dd
end_date string 是 结束日期， 格式为 yyyy-MM-dd
msg_type string 否 短信类型，2表示国际短信
aggregate_by string 否 是否聚合，0不聚合，1聚合，默认为0

注意:

  1. 查询的天数不超过90天
  2. 当 aggregate_by 为 1 时, 会按照 msg_type 做数据聚合；当 aggregate_by 为 0 时, 不做数据聚合

请求示例

curl -X GET "https://sms.api.engagelab.cc/v1/data/stats_day?start_date=2022-11-20&msg_types=0" --header "Authorization: Basic <<YOUR_SMS_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_SMS_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
send_date 发送日期
msg_type 短信类型
sms_user SMS_USER
template_id 短信模板ID
label_id 标签ID
targets 目标总数
sent 发送数量
process_failed 处理失败数量
delivered 送达数量
send_failed 发送失败数量
wait_result 待回执数量
billing_count 计费数量
process_failed_percent 处理失败比例
delivered_percent 送达比例
send_failed_percent 发送失败比例
wait_result_percent 待回执比例

响应示例

不聚合情况下

{ "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
}
此代码块在浮窗中显示

聚合情况下

{ "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
        }
    }
}
此代码块在浮窗中显示

处理失败统计

查询处理失败的分类统计信息

URL

https://sms.api.engagelab.cc/v1/stats/process_failed
          https://sms.api.engagelab.cc/v1/stats/process_failed
此代码块在浮窗中显示

HTTP请求方式

GET
          GET
此代码块在浮窗中显示

Request-Headers

Header 类型 必须 说明
Authorization String true Basic base64(smsUser:smsKey)

参数说明

参数 类型 必须 说明
time_zone string 否 时区，默认时区：+8
sms_users string 否 获取指定 SMS_USER 的统计数据， 多个 SMS_USER 用;分开, 如：sms_users=a;b;c，最大支持10个
start_date string 是 开始日期，格式为 yyyy-MM-dd
end_date string 是 结束日期，格式为 yyyy-MM-dd
msg_type string 否 业务类型，2表示国际短信，默认2
label_ids string 否 短信标签ID列表，用;分开，如 label_ids=123456;456789，最大支持10个
template_ids string 否 多个模板ID，用;分开，如：template_Ids=1;2;3，最大支持10个
aggregate_by string 否 是否聚合，0不聚合，1聚合，默认为0

注意:

  1. 查询的天数不超过90天
  2. 当 aggregate_by 为 1 时, 会按照 msg_type 做数据聚合；当 aggregate_by 为 0 时, 不做数据聚合

请求示例

curl -X GET "https://sms.api.engagelab.cc/v1/stats/process_failed?start_date=2022-11-20&msgTypeStr=0" --header "Authorization: Basic <<YOUR_SMS_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_SMS_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
send_date 发送日期
label_id 标签ID
msg_type 短信类型
sms_user SMS_USER
template_id 短信模板ID
global_block 全局拦截个数
partial_block 局部拦截个数
unsubscribe 取消订阅个数
keyword_block 关键词过滤个数
variable_error 替换变量错误个数
content_error 内容不符合规范个数
frequency_overrun 频率超限个数
other 其他个数

响应示例

不聚合情况下

{ "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
}
此代码块在浮窗中显示

聚合情况下

{ "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
        }
}
此代码块在浮窗中显示

发送失败统计

查询发送失败的分类统计信息

URL

https://sms.api.engagelab.cc/v1/stats/send_failed
          https://sms.api.engagelab.cc/v1/stats/send_failed
此代码块在浮窗中显示

HTTP请求方式

GET
          GET
此代码块在浮窗中显示

Request-Headers

Header 类型 必须 说明
Authorization String true Basic base64(sms_user:sms_key)

参数说明

参数 类型 必须 说明
time_zone string 否 时区，默认时区：+8
sms_users string 否 获取指定 SMS_USER 的统计数据， 多个 SMS_USER 用;分开, 如：sms_users=a;b;c，最大支持10个
start_date string 是 开始日期, 格式为 yyyy-MM-dd
end_date string 是 结束日期, 格式为 yyyy-MM-dd
msg_type string 否 短信类型，2表示国际短信
label_ids string 否 短信标签ID列表，用;分开，如 label_Ids=123456;456789 ，最大支持10个
template_ids string 否 多个模板ID，用;分开, 如：template_Ids=1;2;3 ，最大支持10个
aggregate_by string 否 是否聚合, 0不聚合，1聚合，默认为0

注意:

  1. 查询的天数不超过90天
  2. 当 aggregate_by 为 1 时, 会按照 msg_type 做数据聚合；当 aggregate_by 为 0 时, 不做数据聚合

请求示例

curl -X GET "https://sms.api.engagelab.cc/v1/data/sendFailed?start_date=2022-11-20&msg_type=0" --header "Authorization: Basic <<YOUR_SMS_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_SMS_KEY_HERE>>"
此代码块在浮窗中显示

响应说明

字段 说明
send_date 发送日期
label_id 标签ID
msg_type 短信类型
sms_user SMS_USER
template_id 短信模板ID
empty 空号个数
out_of_service 停机个数
blacklist 黑名单个数
busy 占线个数
no_answer 无人接听个数
interception 拦截个数
break_down 手机故障个数
not_in_service 不在服务区个数
power_off 关机个数
other 其他

响应示例

不聚合情况下

{ "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
    }
}
此代码块在浮窗中显示

聚合情况下

{ "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
        }
    
}
此代码块在浮窗中显示
在文档中心打开