# 创建发短信任务

调试工具

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

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

# 接口说明

# 接口英文名

createSendSmsTask

# 功能描述

该接口用于创建发短信任务。发送的短信支持打开云开发静态网站 H5,进而在 H5 里可以打开小程序。详情可参考静态网站 H5 跳小程序

# 注意事项

# 短信格式:

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

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

  • 短信签名是位于短信正文前【】中的署名,小程序发送短信时,签名为小程序名称。
  • 正文内容是由短信模板和变量构成,{1},跳转小程序 {2},拒收请回复R,模板参数中 {1},{2} 是变量:

{1} :用户可自定义传入的内容,当前最长为30个字。

{2} :用户传入的静态托管的地址,例如 /action/index.html?action=double12。

# 通过该 API 来实现发短信的完整过程:

1、下载 CSV 模版文件,并按格式填写手机号、短信内容、跳转的静态托管地址

2、上传填写后的 CSV 文件, 并获取CodeUri。

  • 调用描述扩展上传文件信息(详见describeExtensionUploadInfo接口),获取上传链接 UploadUrl(FileType 参数填 SMS)
  • 使用 HTTP PUT 方法请求 UploadUrl 上传 CSV 文件

3、调用本 API,创建发短信任务,并获取到查询 ID

4、通过查询 ID 可以查询短信任务的执行情况,详见describeSmsRecords接口。

# 调用方式

# HTTPS 调用


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

# 云调用

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

  • 接口方法为: openapi.cloudbase.createSendSmsTask

# 第三方调用

  • 调用方式以及出入参和HTTPS相同,仅是调用的token不同

  • 该接口所属的权限集id为:49、64

  • 服务商获得其中之一权限集授权后,可通过使用authorizer_access_token代商家进行调用

# 请求参数

属性 类型 必填 说明
access_token string 接口调用凭证,该参数为 URL 参数,非 Body 参数。使用access_token或者authorizer_access_token
env string 环境 ID
file_url string 短信 CSV 文件地址CodeUri
template_id string 短信模版 ID 默认值:2053122(销类短信模版 ID)
use_short_name boolean

# 返回参数

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
query_id string 查询 ID

# 调用示例

示例说明: HTTPS调用

# 请求数据示例


{
  "env":"xxx",
  "file_url":"xxx"
} 

# 返回数据示例


{
  "errcode":0,
"errmsg":"ok"
  "query_id":"xxx"
}
 

示例说明: 云函数调用

# 请求数据示例


const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.cloudbase.createSendSmsTask({
        "env": 'xxx',
        "fileUrl": 'xxx'
      })
    return result
  } catch (err) {
    return err
  }
} 

# 返回数据示例


{
  "errCode": 0,
  "queryId": "xxx",
  "errMsg": "openapi.cloudbase.createSendSmsTask:ok"
} 

# 错误码

错误码 错误码取值 解决方案
-1 system error 系统繁忙,此时请开发者稍候再试