果创云开放接口

01501 阿里云发送短信接口

接口地址:http://api.yesapi.cn/?s=App.Sms.AliyunSendSms

接口描述: 通过阿里云的SendSms发送短信,使用前请进入小白开放平台-阿里云短信配置

接口标签:免费(每月最高10万次)付费(包月/按量/私服)验签

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

在线测试    添加收藏    直接访问接口


接口参数

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包
如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。通过在线测试工具可进行签名的对比和调试。 企业版支持专属签名算法定制。
uuid字符串可选最大:32UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。
token字符串可选最小:64;最大:64当前登录会员的会话凭证,可通过会员登录接口获得。
PhoneNumbers字符串必须接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。
SignName字符串必须短信签名名称。可在阿里云控制台签名管理页面签名名称一列查看。例如:阿里云
TemplateCode字符串必须短信模板ID。可在阿里云控制台模板管理页面模板CODE一列查看。例如:SMS_153055065
TemplateParam字符串JSON格式可选短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"}

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
PhoneNumbers 必须
SignName 必须
TemplateCode 必须
TemplateParam 可选

客户端请求示例

查看我的接口域名、app_key和app_secrect 客户端接入指南(如何生成签名) 开启/关闭签名

请求:
{你的接口域名}/?s=App.Sms.AliyunSendSmsPhoneNumbers=15988888888&SignName=小白开放平台&TemplateCode=SMS_153055065&TemplateParam={"name":"xxx"}&app_key={你的app_key}&sign={动态签名}

返回:
{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "Message":"OK",
        "RequestId":"2184201F-BFB3-446B-B1F2-C746B7BF0657",
        "BizId":"197703245997295588^0",
        "Code":"OK"
    },
    "msg": "小白开放接口:App.Sms.AliyunSendSmsPhoneNumbers"
}

接口使用帮助说明

小白君正在拼命补充中……

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.操作码,0成功,1失败err_code
data.BizId字符串发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。
data.Code字符串请求状态码。返回OK代表请求成功。其他错误码详见错误码列表
data.Message字符串状态码的描述。
data.RequestId字符串请求ID。
msg字符串提示信息,面向技术人员的帮助或错误提示信息

ret异常错误码

错误码错误类型错误描述信息解决方法
ret = 200成功请求成功
ret = 400客户端非法请求表示客户端参数错误1、根据接口文档的接口参数,提供正确的参数
ret = 404客户端非法请求表示接口服务不存在1、查看小白接口大全,确保接口服务名称拼写正确
ret = 500果创云开放接口异常表示服务端内部错误1、进入QQ交流群897815708,反馈问题;2、或者提交工单,一天内回复

常见问题FAQ

Q1 问:出现 414 Request-URI Too Large 时怎么解决?答:对于全部参数,改用POST方式传递,并且从GET链接里面去掉。