查询短信记录

接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

接口英文名：describeSmsRecords

该接口用于查询 2 个月内的短信记录。

1. 调用方式

HTTPS 调用

POST https://api.weixin.qq.com/tcb/describesmsrecords?access_token=ACCESS_TOKEN

云调用

• 调用方法：cloudbase.describeSmsRecords

• 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档。

第三方调用

• 本接口支持第三方平台代商家调用。

• 该接口所属的权限集 id 为：49

• 服务商获得其中之一权限集授权后，可通过使用 authorizer_access_token 代商家进行调用，具体可查看 第三方调用 说明文档。

2. 请求参数

查询参数 Query String Parameters

请求体 Request Payload

3. 返回参数

返回体 Response Payload

Res.SmsRecords(Array) Object Payload

发送记录列表

4. 注意事项

本接口无特殊注意事项

5. 代码示例

5.1 HTTPS调用

请求示例

{
  "PostData": {
    "StartDate": "2021-03-01",
    "EndDate": "2021-03-23",
    "EnvId": "xxx",
    "QueryId": "xxx",
    "PageNumber": 1,
    "PageSize": 20
  }
}

返回示例

{
  "SmsRecords": [
    {
      "Content": "【XXX】XXX，跳转小程序 https://xxx/xxx 回T退订",
      "ContentSize": 51,
      "CreateTime": "2021-03-22 17:18:37",
      "Fee": 1,
      "Mobile": "+86xxxxxxxxxxx",
      "ReceivedTime": "2021-03-22 17:18:43",
      "Remarks": "用户短信接收成功",
      "Status": "sent"
    }
  ],
  "TotalCount": 1,
  "RequestId": "bf34127a-35bd-48a2-86bb-ae583d2ff9ff"
}

5.2 云函数调用

请求示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi({ convertCase: false }).cloudbase.describeSmsRecords({
        "PostData": {
          "StartDate": '2021-03-01',
          "EndDate": '2021-03-23',
          "EnvId": 'xxx',
          "QueryId": 'xxx',
          "PageNumber": 1,
          "PageSize": 20
        }
      })
    return result
  } catch (err) {
    return err
  }
}

返回示例

{
  "Response": {
    "SmsRecords": [
      {
        "Content": "【XXX】XXX，跳转小程序 https://xxx/xxx 回T退订",
        "ContentSize": 51,
        "CreateTime": "2021-03-22 17:18:37",
        "Fee": 1,
        "Mobile": "+86xxxxxxxxxxx",
        "ReceivedTime": "2021-03-22 17:18:43",
        "Remarks": "用户短信接收成功",
        "Status": "sent"
      }
    ],
    "TotalCount": 1,
    "RequestId": "bf34127a-35bd-48a2-86bb-ae583d2ff9ff"
  },
  "errMsg": "openapi.cloudbase.describeSmsRecords:ok"
}

6. 错误码

以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

7. 适用范围