通过手机号验证
接口描述
接口请求域名:sms.api.juphoon.com
接口原型
- 方法:POST
- 接入点:/verify/v1/phone
参数说明
请求头
以下请求参数列表仅列出了接口请求参数。
参数名称 | 类型 | 必选 | 描述 |
X-Jcc-Authorization | String | 是 | HTTP 身份认证头部字段,凭证信息生成方式在实现方法中说明。 |
输入参数
参数名称 | 必选 | 类型 | 描述 |
to | 是 | String | 下发手机号码,采用 E.164 标准,格式为+[国家或地区码] [手机号],单次请求仅支持1个手机号,且只支持向境外手机号发送短信。例如:+ 13137992197, 其中前面有一个+号 ,1为国家码,3137992197为手机号。参数长度不能超过20字符。 |
templateId | 是 | String | 短信模版 ID,必须填写已审核通过的模版 ID。参数长度不能超过20个字符。 |
verificationCode | 是 | String | 验证码。 |
输出参数
参数名称 | 类型 | 描述 |
code | String | 短信请求错误码,具体含义请参考错误码 ,验证成功返回 "OK"。 |
msg | String | 短信请求错误码描述。 |
异常输出
正常输出