发送阿里云短信通知
接口描述
接口URL
请求方式
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、接口调用频率限制,单个用户、IP每日短信发送上限2000,单个手机号每日发送上限10条
3、使用前账号需要配置阿里云短信模板
请求参数描述
appId
true
String
timestamp
true
Long
当前13位毫秒级时间戳,3分钟内有效
sign
true
String
请求体参数描述
phoneNumbers
true
Array
手机号,长度11位,最大200个
templateParamNames
true
Array
短信模板的参数名
templateParamValues
true
Array
短信模板参数名对应的参数值,与参数名一一对应
示例
请求体json参数:
响应参数描述
code
Integer
状态码,与 http 状态码相同,用于确定基本的响应状态
status
String
响应结果,由业务决定,成功返回success,失败返回error
success
Boolean
是否成功响应
requestId
String
请求ID,每次请求生成的唯一的 UUID,仅可用于排查、调试,不应该和业务挂上钩
error
Object
data
Array
Error参数描述
code
Integer
错误代码,用于确定具体的错误原因
desc
String
错误描述,与 error.code 对应
data参数描述
phoneNumber
String
手机号
status
Integer
短信状态 -1:发送失败,手机号超过每日发送频次限制 -2:发送失败,手机号不合法(非数字、长度错误) 11:发送失败(调用阿里云短信接口失败) 12:发送成功(调用阿里云短信接口成功,进入短信发送队列等待发送,并非成功发送到手机)
serialNo
String
发送成功时返回阿里云回执ID流水号
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 LiveSignUtil.java 都包含在下载文件中。
强烈建议您使用直播Java SDK完成API的功能对接,直播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
响应示例
系统全局错误说明详见全局错误说明
成功示例
异常示例
Last updated
Was this helpful?