HTTP/HTTPS
请求协议
EagletAPI / OpenAPI / 生成发短信二维码
生成发短信二维码
接口地址:http://api.kittyhawks.cn/api/app.php?s=App.QrCode.Sms
接口描述: 根据手机号生成二维码,生成后手机扫码后可直接进入短信编辑发送界面
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
level | 枚举类型 | 可选 | H | 范围:L/M/Q/H | 错误纠正级别,L为最小,H为最佳 |
size | 整型 | 可选 | 6 | 最小:1;最大:10 | 二维码尺寸大小 |
output | 布尔型 | 可选 | true | 是否直接显示二维码,否的话通过base64返回二维码数据 | |
phone_number | 字符串 | 必须 | - | 手机号,接收短信的手机号 |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
level | 可选 | |
size | 可选 | |
output | 可选 | |
phone_number | 必须 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/App.QrCode.Sms.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | 表示客户端参数错误 |
404 | 表示接口服务不存在 |
500 | 表示服务端内部错误 |
本文档生成时间:2024-11-01 07:52:27