阿拉星球 / 后台接口 / 阿里云发送短信接口

阿里云发送短信接口

接口描述: 通过阿里云的SendSms发送短信。使用前请修改./config/app.php配置文件中的aliYun配置。

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
PhoneNumbers字符串必须-接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。
SignName字符串必须-短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如:阿里云
TemplateCode字符串必须-短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如:SMS_153055065
TemplateParam字符串JSON格式可选-短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"}

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
data.BizId字符串发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。
data.Code字符串请求状态码。返回OK代表请求成功。Config Error代表缺少配置。其他错误码详见错误码列表
data.Message字符串状态码的描述。
data.RequestId字符串请求ID。
msg字符串提示信息,失败时的错误提示

在线测试   

参数是否必须
service 必须
access_token 可选
PhoneNumbers 必须
SignName 必须
TemplateCode 必须
TemplateParam 可选

客户端请求示例

# 暂无示例,可添加示例文件:./src/view/docs/demos/Admin.Sms.AliyunSendSms.json

错误列表

错误状态码错误描述信息
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

本文档生成时间:2020-11-30 00:26:10