更新时间:2023-08-21 GMT+08:00
分享

查询智能信息发送报表

功能介绍

查询智能信息发送报表。

URI

POST /v1/aim/send-reports

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:0

最大长度:2000

Content-Type

String

请求体参数类型,该字段必须设置为:application/json。

表2 请求Body参数

参数

是否必选

参数类型

描述

report_type

String

报表类型。

  • 1:日报表

  • 2:月报表

说明:

若不填,默认是1,即查询日报表。

最小长度:0

最大长度:8

tpl_id

String

智能信息模板ID。

最小长度:0

最大长度:9

tpl_name

String

智能信息模板名称。

最小长度:0

最大长度:100

begin_time

String

开始时间。格式为:2022-05-01T00:00:00Z。

最小长度:0

最大长度:30

end_time

String

结束时间。格式为:2022-05-01T00:00:00Z。

最小长度:0

最大长度:30

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0。

说明:

为提高查询效率,offset+limit须小于等于10000,超出范围查询为空。

最小值:0

最大值:2147483647

缺省值:0

limit

Integer

每页显示的条目数量。

最小值:1

最大值:100

缺省值:20

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

status

String

响应码。

message

String

响应信息。

data

QueryReportResponse object

响应数据体。

表4 QueryReportResponse

参数

参数类型

描述

data_list

Array of ReportDetail objects

数据列表。

数组长度:0 - 100

page_info

Page object

分页信息。

表5 ReportDetail

参数

参数类型

描述

report_time

String

报表日期时间。

tpl_id

String

智能信息模板ID。

tpl_name

String

智能信息模板名称。

submission_count

Integer

提交号码总数量。

support_resolve_count

Integer

支持解析数量。

说明:

此数据不包括通过API发送的智能信息任务。

send_count

Integer

发送数量。

send_success_count

Integer

成功发送数量。

resolve_success_count

Integer

成功解析数量。

表6 Page

参数

参数类型

描述

offset

Integer

偏移量,表示从此偏移量开始查询,offset大于等于0。

limit

Integer

每页显示的条目数量。

total

Integer

总条数。

状态码: 400

表7 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明:

该字段在以后可能会废弃,建议使用error_msg字段对接。

状态码: 500

表8 响应Body参数

参数

参数类型

描述

error_code

String

结果状态码。

error_msg

String

结果详情。

error_message

Object

结果详情。

说明:

该字段在以后可能会废弃,建议使用error_msg字段对接。

请求示例

  • 查询智能信息发送报表-日报。模板ID为"600000005",查询时间从"2022-07-15 00:00:00 到 2022-07-16 00:00:00"。

    https://koomessage.myhuaweicloud.com/v1/aim/send-reports
    
    {
      "begin_time" : "2022-07-15T00:00:00Z",
      "end_time" : "2022-07-16T00:00:00Z",
      "report_type" : "1",
      "tpl_id" : "600000005",
      "offset" : 0,
      "limit" : 2
    }
  • 查询智能信息发送报表-月报。模板ID为"600000006",查询时间从"2022-05-01 00:00:00 到 2022-07-01 00:00:00"。

    https://koomessage.myhuaweicloud.com/v1/aim/send-reports
    
    {
      "begin_time" : "2022-05-01T00:00:00Z",
      "end_time" : "2022-07-01T00:00:00",
      "report_type" : "2",
      "tpl_id" : "600000006",
      "offset" : 0,
      "limit" : 2
    }

响应示例

状态码: 200

返回信息。

{
  "status" : "200",
  "message" : "success",
  "data" : {
    "data_list" : [ {
      "report_time" : "2022-07-15",
      "tpl_id" : "600000005",
      "tpl_name" : "【惠游重庆】入境欢迎-测试",
      "submission_count" : 4,
      "support_resolve_count" : 3,
      "send_count" : 0,
      "send_success_count" : 0,
      "resolve_success_count" : 0
    } ],
    "page_info" : {
      "offset" : 1,
      "limit" : 2,
      "total" : 1
    }
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品