应用身份管理服务 ONEACCESS-发送短信验证码:请求参数

时间:2024-08-30 15:55:32

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

该字段内容填为“application/json;charset=utf8”。

X-operating-sys-version

String

调用方操作系统版本,该参数只用来记录日志,不做校验。例如:Android 10。

X-device-fingerprint

String

调用方设备指纹,该参数只用来记录日志,不做校验。例如:156aysdna213sc50。

X-device-ip

String

调用方IP,该参数只用来记录日志,不做校验。例如:10.10.10.1。

X-agent

String

用户Agent信息,该参数只用来记录日志,例如:Mozilla/5.0 (Linux; Android 10; Redmi K30 Build/QKQ1.190825.002; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/80.0.3987.99 Mobile Safari/537.36。

X-L

String

用于国际化语言设置,支持中文和英文。例如:zh。

X-client-id

String

应用标识,注册应用后分配的ClientId。该值可参考通用信息获取。

X-tenant-id

String

租户id,ISV应用调用则为必填,需要将{domain_name}换成ISV通用 域名 {common_domain},请求Header参数中需要指定对应租户的tenant_id,并将X-client-id换成ISV应用模板的client_id。

说明:

此参数只用于ISV应用,当前该应用暂未开放,若需要,请提交工单申请开通。

表2 请求Body参数

参数

是否必选

参数类型

描述

mobile

String

手机号,只能由数字组成,且长度为11位。

type

String

短信发送的场景,该参数用来设置在以下哪种场景下收到验证码。

枚举值:

  • REGISTER_ SMS :注册短信
  • LOG IN_SMS:登录短信
  • FORGET_PWD_SMS:找回密码短信
  • BIND_MOBILE_SMS:绑定短信
  • UPDATE_MOBILE_SMS:修改手机号短信
  • OTP_REST_SMS:二次认证短信

captcha_token

String

图形验证码校验通过的凭证。该参数获取方式参考校验图形验证码

support.huaweicloud.com/api-oneaccess/SendSmsVerifyCode.html