Skip to content

SysKey 接口 ​

SysKey 方式使用简单的 GET 接口,通过 syskey 识别请求者,适合快速集成轻量场景。

参数别名

syskey 也可写作 sys_key;签名参数支持 signname、sign_name、SignName 三种写法,方便对接不同系统。

通用响应 ​

成功响应(HTTP 200) ​

json
{
  "Code": "OK",
  "Message": "短信已发送",
  "RequestId": "unique_id"
}

失败响应 ​

json
{
  "Code": "InvalidParameter",
  "Message": "缺少必要参数 (syskey, phone)",
  "RequestId": ""
}

失败时 Code 为对应错误码,详见 错误码。部分早期失败的响应可能不包含 RequestId 字段。

验证码模式 ​

验证码模式用于直接发送验证码,也是 SysKey 的默认使用方式。

请求 URL ​

http
GET /?syskey=sk_xxx&phone=12345678911&code=123456

参数说明 ​

参数必填说明
syskey是短信后台的 SysKey(也支持 sys_key)。
phone是11 位手机号码。
code是验证码,4-6 位数字。
signname否指定本次发送使用的 106 签名前缀。仅会员账户生效,免费用户传入会被忽略并强制使用系统默认签名。

响应示例 ​

json
{
  "Code": "OK",
  "Message": "短信已发送",
  "RequestId": "unique_id"
}

模板模式 ​

模板模式用于通过后台已审核模板发送自定义内容。template_id 直接填写阿里云模板 ID。

请求 URL ​

http
GET /?syskey=sk_xxx&phone=12345678911&template_id=SMS_500650100&code={"name":"张三","order":"12345"}

参数说明 ​

参数必填说明
syskey是短信后台的 SysKey。
phone是11 位手机号码。
template_id是模板 ID,从用户申请的模板后台获取。
code是模板参数,JSON 格式字符串。
signname否指定本次发送使用的 106 签名前缀。仅会员账户生效。

code 参数格式 ​

  • 必须是有效 JSON 字符串,否则返回 InvalidParameter。
  • JSON 中的 key 对应模板变量,例如 {name}、{order}。
  • 示例:{"name":"张三","order":"12345"} 对应模板参数“尊敬的{name},您的订单{order}已发货”。
  • 如果模板没有任何变量,也需要传入非空 JSON,例如 {"placeholder":"placeholder"}。

响应示例 ​

json
{
  "Code": "OK",
  "Message": "短信已发送",
  "RequestId": "unique_id"
}

异常示例 ​

json
{
  "Code": "InvalidTemplate",
  "Message": "模板不存在或未通过审核"
}

计费说明 ​

发送成功后按短信实际内容长度扣费:每 50 字计为 1 条(不足 50 字按 1 条计算),从短信包余额中扣除。发送失败不扣费。