发送模板短信接口

注意

• 发送短信前需要申请 短信签名 和 短信模板

请求说明

• 接口请求域名 : api.ffrcs.cn
• RequestURI : /rest/sms/v3/send/templateSms
• Method : POST
• Content-Type : application/json; charset=utf-8;

默认接口请求频率限制：300次/秒。

输入参数

参数	类型	描述	示例	必填
signName	String	短信签名。需要带【】符号。	【飞鱼短信】	是
templateId	Integer	短信模板ID。	10830	是
mobiles	TemplateVariable[]	发送短信的手机号码列表。 单次请求最多支持200个手机号。		是
subCode	String	短信扩展码。注意：格式为纯数字。	00001	否
smsId	String	任务ID。最大支持32位字符。 如不填写则由本平台自动生成		否
sendTime	String	定时发送时间。格式为：yyyy-MM-dd HH:mm:ss。	2018-07-03 17:47:43	否

TemplateVariable

参数	类型	描述	示例	必填
mobile	String	手机号码。	180****	是
variables	String[]	模板参数。若无模板参数，则设置为空。	["1232"]	否

响应内容

参数	类型	描述
code	Integer	响应状态
message	String	响应状态描述
data	Object	响应结果
data.smsId	String	本次请求返回的唯一消息ID。
data.failList	InvalidMobile[]	响应结果

InvalidMobile

参数	类型	描述
mobile	String	手机号码。
code	Integer	当前手机号发送失败的状态码。
message	String	当前手机号发送失败的状态描述。

示例

请求示例

短信模板无变量

curl  'https://api.ffrcs.cn/rest/sms/v3/send/templateSms' \
--header 'Content-Type: application/json' \
--header 'X-FZ-Timstamp: 1713152159772 ' \
--header 'Authorization: HmacSHA256 credential=1kl***,signature=1264b693*******be05bef' \
--data '{
    "signName": "【飞鱼短信】",
    "templateId": 10830,
    "mobiles": [
        {
            mobile: "180********",
            variables: null,
        }
    ]
}'

短信模板带变量

curl  'https://api.ffrcs.cn/rest/sms/v3/send/templateSms' \
--header 'Content-Type: application/json' \
--header 'X-FZ-Timstamp: 1713152159772 ' \
--header 'Authorization: HmacSHA256 credential=1kl***,signature=1264b693*******be05bef' \
--data '{
    "signName": "【飞鱼短信】",
    "templateId": 10831,
    "mobiles": [
        {
            mobile: "180********",
            variables: ["923732"],
        }
    ]
}'

发送预览

- 模板内容示例：【飞鱼短信】您的验证码是{1}，有效期10分钟，请勿泄漏。
+ 发送内容示例：【飞鱼短信】您的验证码是923732，有效期10分钟，请勿泄漏。

响应示例

{
  "code": 200,
  "message": "处理成功",
  "data": {
    "smsId": "b1f41b725bb543a8b0066d483f9cae30",
    "failList": null
  }
}

错误码参考- 错误码