# 发送短信

# 接口描述

接口请求域名:sms.api.juphoon.com。 短信发送接口,用于给用户发短信验证码、通知类短信。

# 接口原型

  • 方法:POST
  • 接入点:/sms/v1

# 输入参数

以下请求参数列表仅列出了接口请求参数。

参数名称 必选 类型 描述
to String 下发手机号码,采用 E.164 标准,格式为+[国家或地区码][手机号],单次请求仅支持1个手机号,且只支持向境外手机号发送短信。例如:+ 13137992197, 其中前面有一个+号 ,1为国家码,3137992197为手机号。参数长度不能超过20字符。
templateId String 短信模板 ID,必须填写已审核通过的模板 ID。参数长度不能超过20个字符。
templateParams Array of String 模板参数,若无模板参数,则设置为空。变量长度不能超过20个字符。模板参数的个数需要与templateId 对应模板的变量个数保持一致。
bizId String 预留给调用方使用的业务ID,最终会通过回执消息将此ID带回给调用方。参数长度不能超过100个字符。

# 输出参数

参数名称 类型 描述
smsId String 短信的唯一标识。
code String 短信请求错误码,具体含义请参考错误码 ,发送成功返回 "OK"。
msg String 短信请求错误码描述。

# 示例

# 输入示例

POST /sms/v1 HTTP/1.1
Host: sms.api.juphoon.com
X-Jcc-Authorization: J-HMAC-SHA256 key-id="5c9ae***",signed-headers="x-jcc-timestamp;x-jcc-service",signature="/ka5hJrhYMDZu+Y+Xssmt/V45IyDsrNrSDL8MR2EY4s="
X-Jcc-Timestamp: 1650437553
X-Jcc-Service: jcc-api
Content-Type: application/json
Content-Length: 150

{"templateId": "T8aed15***", "templateParams": ["121234"], "to": "+13137992***", "bizId": "123"}

# 输出示例

{
    "smsId": "aca4be91-04e3-4191-97f7-27d6227*****",
    "code":"OK",
    "msg":"OK",
}

最后更新时间: 2022/4/22 09:23:40