七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
短信

获取使用中的短信模板

获取企业下审核通过且处于使用状态的短信模板列表。短信服务需已注册并开启。请求体可为空 JSON。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和
checksumAlgorithmint32否签名算法:0 - 默认(SHA1),1 - SHA256

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring提示信息success
dataobject[]模板列表
└idint64模板 ID1001
└namestring模板名称验证码模板
└typeint32模板类型,1-验证码 2-通知 3-营销1
└contentstring模板内容您的验证码是%s,有效期5分钟。

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体为空
14500服务内部异常
67407短信服务未开启或未注册
postEndpoint
/openapi/smstask/templates
POST
/openapi/smstask/templates
curl -X POST "https://qiyukf.com/openapi/smstask/templates?appKey=string&time=0&checksum=string"
{
  "code": 200,
  "message": "success",
  "data": [
    {
      "id": 1001,
      "name": "验证码模板",
      "type": 1,
      "content": "您的验证码是%s,有效期5分钟。"
    }
  ]
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体为空"
}
{
  "code": 14500,
  "message": "服务内部异常"
}
{
  "code": 67407,
  "message": "短信服务未开启或未注册"
}

这篇文档有帮助吗?