HTTP/HTTPS
请求协议
果果云 / OpenAPI / 阿里云发送短信接口
阿里云发送短信接口
接口地址：http://lite-demo.yesapi.cn/api/app.php?s=App.Sms.AliyunSendSms
接口描述： 通过阿里云的SendSms发送短信。使用前请修改./config/app.php配置文件中的aliYun配置。
接口参数
| 参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
|---|---|---|---|---|---|
| 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 | 对象或混合类型 | 业务数据，由各自接口指定，通常为对象 |
| msg | 字符串 | 提示信息，失败时的错误提示 |
在线测试
| 参数 | 是否必须 | 值 |
|---|---|---|
| service | 必须 | |
| access_token | 可选 | |
| PhoneNumbers | 必须 | |
| SignName | 必须 | |
| TemplateCode | 必须 | |
| TemplateParam | 可选 |
客户端请求示例
{
"ret": 200,
"data": {
"Message": "OK",
"RequestId": "4674148E-F8CE-4CBA-AF26-D3F13B7F5162",
"BizId": "734404282527581474^0",
"Code": "OK"
},
"msg": ""
}错误列表
| 错误状态码 | 错误描述信息 |
|---|---|
| 400 | ret=400，客户端参数错误或非法请求 |
| 404 | 表示接口服务不存在 |
| 406 | ret=406，access_token令牌校验不通过 |
| 407 | ret=407，app_key权限不足，或未知应用 |
| 408 | ret=408，当前用户禁止使用，或用户未登录 |
| 409 | ret=409，接口流量不足 |
| 410 | ret=410，接口限流 |
| 500 | 表示服务端内部错误 |
本文档生成时间：2024-12-21 22:33:41