# 发送验证码

# 接口描述

接口请求域名:sms.api.juphoon.com

# 接口原型

  • 请求方法: POST
  • 请求地址:/verification /v1

# 参数说明

# 请求头

参数名称 类型 必选 描述
X-Jcc-Authorization String HTTP 身份认证头部字段,凭证信息生成方式在实现方法中说明。

# 输入参数

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

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

# 输出参数

参数名称 类型 描述
code String "OK"-成功,其他-失败。
msg String 错误信息描述。
smsId String 短信的唯一标识。

# 异常输出

{
    "smsId": null,
    "code": "UnsupportedCountry",
    "msg": "不支持该地区短信下发"
}

# 正常输出

{
    "smsId": "f9bd7c9e3dca47b1827d9552ddea9f92",
    "code": "OK",
    "msg": "成功"
}
最后更新时间: 2023/4/19 17:13:53