小白接口

发送国内短信验证码 Supplier.YesApi.SendSmsCode

接口路径(新):http://api.okayapi.com/api/Supplier/YesApi/SendSmsCode

接口路径(旧):http://api.okayapi.com/?s=Supplier.YesApi.SendSmsCode

接口描述: 适用于验证码等场景所发送的短信,多套模板可选,初创企业最佳选择,无门槛零负担。

免费
3次

接口标签:服务大厅MyApi验签

流量权重
1
请求协议
HTTP/HTTPS
请求方式
GET/POST(推荐POST)
编码格式
UTF-8
返回格式
JSON
供应商
已认证

在线测试    添加收藏    直接访问接口    我要二开此接口    接口请求日记


接口参数 若无特殊说明,接口参数同时支持GET和POST传递;推荐:查询/删除用GET,创建/更新用POST。

参数名字参数类型是否必须默认值备注参数说明
app_key字符串必须最小:32公共参数 开发者应用的app_key,查看我的app_key,如果还没有,可免费注册开通。
sign字符串可选公共参数接口签名,其中:
  • 使用动态签名,签名生成算法请见:如何生成签名,或直接使用封装好的SDK开发包,通过在线测试工具可进行签名的对比和调试。
  • 使用静态签名点击获取我的静态签名
  • 关闭签名,如果不需要签名,可进入小白开放平台接口签名设置关闭或开启签名。
  • 定制签名支持专属签名算法定制开发
uuid字符串可选最大:32公共参数 UUID,当前登录的应用会员ID,即全局唯一用户ID,查看我的应用会员。传递此参数后,可以在开放平台查看每日活跃会员统计图表。uuid需要和token一起传递。
token字符串可选最小:64;最大:64公共参数 当前登录会员的会话凭证,可通过会员登录接口获得。uuid需要和token一起传递。
return_data字符串可选0公共参数 数据返回结构,其中:
  • return_data=0,返回完整的接口结果,示例:{"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,欢迎使用小白开放接口!"},"msg":"V3.1.0 YesApi App.Hello.World"}
  • return_data=1,返回简洁的接口结果,只返回data字段,结构简化一级,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,欢迎使用小白开放接口!"}
mobile字符串必须最小:11;最大:11收件手机号,国内11位手机号,例如:13800138000
sms_sign字符串必须YesApi最小:2;最大:16短信签名,2-16 个字符,固定签名可用:【YesApi】、【YesDev】、或【果创云】。如若添加自己的签名,请先实名认证,再提交工单申请。
template_id字符串必须最小:1短信模板 ID,例如:pub_verif_short
template_data字符串必须最小:1JSON格式,模板变量,可以在code中填入你的验证码,例如:{"code": "9153"}

在线测试

参数是否必填
s 必须
uuid 可选
token 可选
return_data 可选
mobile 必须
sms_sign 必须
template_id 必须
template_data 必须

客户端请求示例

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

{
    "ret": 200,
    "data": {
        "err_code": 0,
        "err_msg": "",
        "send_status": "sent"
    },
    "msg": "当前小白接口:Supplier.YesApi.SendSmsCode"
}

接口使用帮助说明

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

返回结构说明

返回字段类型说明
ret整型接口状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务端异常,查看异常错误码
data.err_code整型状态码,0发送成功,1发送失败,请核对手机号码
data.err_msg字符串错误提示信息
data.send_status字符串发送状态,如:sent
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链接里面去掉。

Q2 问:浏览器请求和在线测试接口正常,但本地程序无法正常获取接口结果答:需要注意UTF编码,以及存在中文和特殊字符时的URL编码。GET请求参数应统一进行URL编码后再请求,POST表单数据正常传递即可。

Q3 问:请求接口时提示JSON格式错误答:请先阅读,然后检测本地传递的参数是否符合JSON格式,使用JSON在线工具辅助检测,注意双引号和特殊符号。确认无误后再重新请求API接口。

Q4 问:出现 405 不允许跨域请求 时怎么办?答:目前不支持跨域请求,可参考用反向代理解决跨域问题等3种解决方案。