更新时间:2024-12-20 GMT+08:00
分享

短信发送详情

功能介绍

短信发送详情,接口仅支持开通短信套餐的中国移动与中国电信卡调用

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v1/sms-send-infos/details

表1 Query参数

参数

是否必选

参数类型

描述

limit

Long

分页查询时每页显示的记录数,默认值为10,取值范围为10-500的整数

最小值:10

最大值:500

缺省值:10

offset

Long

分页查询时的页码数,默认值为1,取值范围为1-1000000的整数

最小值:1

最大值:1000000

缺省值:1

cid

String

容器ID

start_time

String

开始时间

end_time

String

结束时间

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

limit

Long

每页的记录数

最小值:10

最大值:500

offset

Long

页码,最小值是1,最大值为1000000。默认值是1.

最小值:1

最大值:1000000

count

Long

记录总数

最小值:0

sms_details

Array of SmsSendDetailQueryVo objects

短信发送详情列表

表4 SmsSendDetailQueryVo

参数

参数类型

描述

cid

String

容器ID

msisdn

String

MSISDN

最大长度:32

sent_time

String

发送时间

received_time

String

接收时间

sms_status

Integer

短信状态:1发送中 2.已送达 3.失败

sms_content

String

短信内容

最大长度:1024

请求示例

查询短信发送详情,每页返回10条数据,从第1页开始。

GET https://{endpoint}/v1/sms-send-infos/details?offset=1&limit=10

响应示例

状态码: 200

OK

{
  "limit" : 10,
  "offset" : 1,
  "count" : 1,
  "sms_details" : [ {
    "cid" : "11669563150033768257",
    "msisdn" : "861400190692085",
    "sent_time" : "2022-03-22T00:00:00.000+00:00",
    "received_time" : "2022-03-22T00:00:00.000+00:00",
    "sms_status" : 2,
    "sms_content" : "testadd321"
  } ]
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档