cloudbase.describeSmsRecords

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

查询 2 个月内的短信记录

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性 类型 默认值 必填 说明
access_token / cloudbase_access_token string 接口调用凭证
EnvId string 环境 ID
StartDate string 开始日期, 如:2021-01-01
EndDate string 结束日期, 如2021-01-07
Mobile string 电话号码
QueryId string 查询ID
PageNumber number 页码(1开始)
PageSize number 每页条目数

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
SmsRecords Array.<Object> 发送记录列表
TotalCount number 记录总数
RequestId string 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

errcode 的合法值

说明 最低版本
0 请求成功
-1 系统繁忙,此时请开发者稍候再试
-501007 参数有误,具体原因参考 errmsg

SmsRecords 的结构

属性 类型 说明
Mobile string 手机号码
Content string 短信内容
ContentSize number 短信内容长度
Fee number 计费条数
CreateTime string 发送时间
ReceivedTime string 用户接收时间
Status string sent(成功), error(失败)
Remarks string 备注

请求数据示例

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

返回数据示例

{
  "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"
  }
}

云调用

云调用是微信云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

openapi.cloudbase.describeSmsRecords

需在 config.json 中配置 cloudbase.describeSmsRecords API 的权限,详情

请求参数

属性 类型 默认值 必填 说明
EnvId string 环境 ID
StartDate string 开始日期, 如:2021-01-01
EndDate string 结束日期, 如2021-01-07
Mobile string 电话号码
QueryId string 查询ID
PageNumber number 页码(1开始)
PageSize number 每页条目数

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
SmsRecords Array.<Object> 发送记录列表
TotalCount number 记录总数
RequestId string 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

errCode 的合法值

说明 最低版本
0 成功

SmsRecords 的结构

属性 类型 说明
Mobile string 手机号码
Content string 短信内容
ContentSize number 短信内容长度
Fee number 计费条数
CreateTime string 发送时间
ReceivedTime string 用户接收时间
Status string sent(成功), error(失败)
Remarks string 备注

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本
-1 系统繁忙,此时请开发者稍候再试
-501007 参数有误,具体原因参考 errmsg

请求数据示例

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"
}