查询发送记录
更新时间 2024-11-08 16:21:55
最近更新时间: 2024-11-08 16:21:55
您可以调用QuerySendDetails接口查看短信发送记录和发送状态。
调用QuerySendDetails接口查看短信发送记录和发送状态。
通过调用QuerySendDetails接口，可以根据短信发送日期查看发送记录和短信内容，也可以添加发送流水号，根据流水号查询指定日期指定请求的发送详情。如果指定日期短信发送量较大，可以分页查看。指定每页显示的短信详情数量和查看的页数，即可分页查看发送记录。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| action | String | 是 | QuerySendDetails | 系统规定参数。取值：QuerySendDetails 。 |
| currentPage | Int | 是 | 1 | 分页查看发送记录，指定发送记录的当前页码。 |
| pageSize | Int | 是 | 10 | 分页查看发送记录，指定每页显示的短信记录数量。取值范围为1~50。 |
| phoneNumber | String | 是 | 1890000**** | 接收短信的手机号码。格式：国内短信：11位手机号码，例如1590000****。 |
| sendDate | String | 是 | 2022-03-28 | 短信发送日期，支持查询最近30天的记录。格式为yyyy-MM-dd，例如2018-12-25。 |
| signName | String | 否 | 签名 | 对应发送内容的签名。 |
| templateCode | String | 否 | SMS73419576145 | 对应发送内容的模板编号。 |
| requestId | String | 否 | 49667481793 | 对用发送时返回的流水号。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| code | String | 0 | 请求状态码。返回OK代表请求成功。其他错误码，请参见错误码列表。 |
| message | String | 成功 | 状态码的描述。 |
| requestId | String | mOiogcaBxn6YgaEQ | 请求ID。 |
| totalCount | Int | 10 | 列表数量。 |
| data | Array | 参考以下 | 短信发送明细。 |
| data.phone | String | 1890000**** | 手机号码。 |
| data.templateCode | String | SMS81136825168 | 短信模板CODE。 |
| data.signName | String | 天翼云 | 签名名称。 |
| data.total | Int | 2 | 该记录所属短信的总发送记录条数。 |
| data.index | Int | 1 | 该记录在所属短信的全部发送记录中的编号。 |
| data.type | Int | 1 | 短信类型，1：验证码，2：短信通知。 |
| data.content | String | 您的验证码为123,有效期为5分钟! | 短信内容。 |
| data.status | Int | 3 | 短信发送状态，1：发送中，2：发送失败，3：发送成功 |
| data.statusCode | String | DELIVRD | 短信的最终发送状态。 |
| data.receiveTime | String | 2022-03-28T06:29:35.171Z | 接收到发送短信请求的时间。 |
| data.deliverTime | String | 2022-03-28T06:29:35.171Z | 下发短信时间。 |
| data.reportTime | String | 2022-03-28T06:29:35.171Z | 接收短信状态报告时间。 |
| data.notifyTime | String | 2022-03-28T06:29:35.171Z | 回调时间。 |
示例
请求示例
{
"action": "QuerySendDetails",
"phoneNumber": "1890000****",
"sendDate": "2022-01-18",
"currentPage": 1,
"pageSize": 10,
"signName":"天翼云",
"templateCode":"SMS13889962005"，
}
正常返回示例
{
"code": 0,
"message": "成功",
"totalCount": 1,
"data": [
{
"_id":"65212dcb79e914605da641ef",
"phone": "1890000****",
"requestId": "TxxfZdCz0sbhddV8",
"templateCode": "SMS81136825168",
"signName": "天翼云",
"total": 0,
"index": 0,
"type": 0,
"content": "您的验证码为123,有效期为5分钟!",
"status": 3,
"statusCode": "DELIVRD",
"receiveTime": "2022-03-28T06:29:34.819Z",
"deliverTime": "2022-03-28T06:29:34.824Z",
"reportTime": "2022-03-28T06:29:35.171Z",
"notifyTime": "2022-03-28T06:29:35.171Z"
}
],
"requestId": "dNFgPWV5Db14vg38"
}
错误码
访问错误码列表查看更多错误码。
