HTTP/HTTPS
请求协议
接口地址:https://www.oapi.cc/store/App.Sms.SendSms
接口描述: 通过接口发送短信
接口参数
参数名字 | 类型 | 是否必须 | 默认值 | 其他 | 说明 |
---|---|---|---|---|---|
access_token | 字符串 | 可选 | 访问令牌,仅当开启签名验证时需要传递,生成令牌可使用App.Auth.ApplyToken接口 | ||
PhoneNumbers | 字符串 | 必须 | - | 接收短信的手机号码。国内短信:11位手机号码,例如15951955195。国际/港澳台消息:国际区号+号码,例如85200000000。 | |
SignName | 字符串 | 必须 | - | 短信签名名称,例如:oapi(需要报备) | |
TemplateCode | 字符串 | 必须 | - | 短信模板ID,例如:SMS_153055065(需要报备) | |
TemplateParam | 字符串JSON格式 | 可选 | - | 短信模板变量对应的实际值,JSON格式。例如:{"code":"1111"} |
返回字段
返回结果 | 类型 | 说明 |
---|---|---|
ret | 整型 | 状态码,200表示成功,4xx表示客户端非法请求,5xx表示服务器错误 |
data | 对象或混合类型 | 业务数据,由各自接口指定,通常为对象 |
data.BizId | 字符串 | 发送回执ID,可根据该ID在接口QuerySendDetails中查询具体的发送状态。 |
data.RequestId | 字符串 | 请求ID。 |
msg | 字符串 | 提示信息,失败时的错误提示 |
在线测试
参数 | 是否必须 | 值 |
---|---|---|
service | 必须 | |
access_token | 可选 | |
PhoneNumbers | 必须 | |
SignName | 必须 | |
TemplateCode | 必须 | |
TemplateParam | 可选 |
客户端请求示例
# 暂无示例,可添加示例文件:./src/view/docs/demos/App.Sms.SendSms.json
错误列表
错误状态码 | 错误描述信息 |
---|---|
400 | 表示客户端参数错误 |
404 | 表示接口服务不存在 |
500 | 表示服务端内部错误 |
本文档生成时间:2025-05-04 19:24:50