果果云 / OpenAPI / 生成发短信二维码

生成发短信二维码

接口描述: 根据手机号生成二维码,生成后手机扫码后可直接进入短信编辑发送界面

HTTP/HTTPS
请求协议
GET/POST
请求方式
UTF-8
编码格式
JSON
返回格式
v1.0
版本号

接口参数

参数名字类型是否必须默认值其他说明
access_token字符串可选访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口
level枚举类型可选H范围:L/M/Q/H错误纠正级别,L为最小,H为最佳
size整型可选6最小:1;最大:10二维码尺寸大小
output布尔型可选true是否直接显示二维码,否的话通过base64返回二维码数据
phone_number字符串必须-手机号,接收短信的手机号

返回字段

返回结果类型说明
ret整型状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误
data对象或混合类型业务数据,由各自接口指定,通常为对象
msg字符串提示信息,失败时的错误提示

在线测试   


参数是否必须
service 必须
access_token 可选
level 可选
size 可选
output 可选
phone_number 必须

客户端请求示例

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

错误列表

错误状态码错误描述信息
400ret=400,客户端参数错误或非法请求
404表示接口服务不存在
406ret=406,access_token令牌校验不通过
407ret=407,app_key权限不足,或未知应用
408ret=408,当前用户禁止使用,或用户未登录
409ret=409,接口流量不足
410ret=410,接口限流
500表示服务端内部错误

本文档生成时间:2024-12-09 11:15:43