cloudbase.sendSms

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

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

发送支持打开云开发静态网站的短信,该 H5 可以打开小程序。详情可参考静态网站 H5 跳小程序

短信格式:

小程序名称${content},点击 云开发静态网站 URL 打开小程序名称小程序,退订回T。 示例:【云开发】能力上新,跳转小程序https://dllzff.cn/VcdrUJK0 退订回T。

短信由签名和正文内容组成:

短信签名是位于短信正文前【】中的署名,小程序发送短信时,签名为小程序名称。

  • 正文内容是由短信模板和变量构成,{1},跳转小程序 {2} 退订回T,模板参数中 {1},{2} 是变量:
  • {1} :用户可自定义传入的内容,当前最长为30个字。
  • {2} :用户传入的静态托管的地址,例如 /action/index.html?action=double12。

调用方式:

HTTPS 调用

请求地址

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

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
envstring环境 ID
phone_number_listArray.<string>手机号列表,单次请求最多支持 1000 个境内手机号,手机号必须以+86开头
contentstring自定义短信内容,一条短信最多为70个字。可自定义内容最多为 30 个字符,详情参考短信规则
pathstring云开发静态网站 path,不需要指定域名,例如/index.html

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
send_status_listArray.<Object>开放数据列表

errcode 的合法值

说明最低版本
0请求成功
-1系统繁忙,此时请开发者稍候再试
-501007参数有误,具体原因参考 errmsg
-601027无效的环境
-601028该环境没有开通静态网站
-601029信息长度过长
-601030信息含有违法违规内容
-601031无效的 Path
-601032小程序昵称不能为空
-601033仅支持非个人主体小程序

send_status_list 的结构

属性类型说明
serial_nostring发送流水号
phone_numberstring手机号码
codestring短信请求错误码
messagestring短信请求错误码描述
iso_codestring国家码或地区码

请求数据示例

  1. {
  2. "env":"online-12345678910",
  3. "phone_number_list":[
  4. "+8612345678910"
  5. ],
  6. "content":"发布了新的能力",
  7. "path":"/index.html"
  8. }

返回数据示例

  1. {
  2. "errcode":0,
  3. "send_status_list":[
  4. {
  5. "serial_no":"8:gFIqWUHzllUyOFRHgeu20201231",
  6. "phone_number":"+8612345678910",
  7. "code":"Ok",
  8. "message":"send success",
  9. "iso_code":""
  10. }
  11. ]
  12. }

云调用

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

接口方法

  1. openapi.cloudbase.sendSms

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

请求参数

属性类型默认值必填说明
envstring环境 ID
phoneNumberListArray.<string>手机号列表,单次请求最多支持 1000 个境内手机号,手机号必须以+86开头
contentstring自定义短信内容,一条短信最多为70个字。可自定义内容最多为 30 个字符,详情参考短信规则
pathstring云开发静态网站 path,不需要指定域名,例如/index.html

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
sendStatusListArray.<Object>开放数据列表

errCode 的合法值

说明最低版本
0成功

sendStatusList 的结构

属性类型说明
serialNostring发送流水号
phoneNumberstring手机号码
codestring短信请求错误码
messagestring短信请求错误码描述
isoCodestring国家码或地区码

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
-1系统繁忙,此时请开发者稍候再试
-501007参数有误,具体原因参考 errmsg
-601027无效的环境
-601028该环境没有开通静态网站
-601029信息长度过长
-601030信息含有违法违规内容
-601031无效的 Path
-601032小程序昵称不能为空
-601033仅支持非个人主体小程序

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init({
  3. env: cloud.DYNAMIC_CURRENT_ENV,
  4. })
  5. exports.main = async (event, context) => {
  6. try {
  7. const result = await cloud.openapi.cloudbase.sendSms({
  8. env: 'online-12345678910',
  9. content: '发布了新的能力',
  10. path: '/index.html',
  11. phoneNumberList: [
  12. +8612345678910
  13. ]
  14. })
  15. return result
  16. } catch (err) {
  17. return err
  18. }
  19. }

返回数据示例

  1. {
  2. "errCode": 0,
  3. "sendStatusList": [
  4. {
  5. "code": "Ok",
  6. "message": "send success",
  7. "serialNo": "8:gFIqWUHzllUyOFRHgeu20201231",
  8. "phoneNumber": "+8612345678910",
  9. "isoCode": ""
  10. }
  11. ],
  12. "errMsg": "openapi.cloudbase.sendSms:ok"
  13. }