更新时间:2024-12-25 GMT+08:00

验证联系方式

功能介绍

验证联系方式

URI

POST /v2/servicerequest/verifycodes

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

最小长度:1

最大长度:5000

X-Language

String

语言环境,值为通用的语言描述字符串,比如zh-cn等,默认为zh-cn。

会根据语言环境对应展示一些国际化的信息,比如工单类型名称等。

最小长度:1

最大长度:32

X-Time-Zone

String

环境时区,值为通用的时区描述字符串,比如GMT+8等,默认为GMT+8。

涉及时间的数据会根据环境时区处理。

最小长度:1

最大长度:32

表2 请求Body参数

参数

是否必选

参数类型

描述

verify_code

String

验证码

最小长度:6

最大长度:6

contact_value

String

联系方式的值

最小长度:0

最大长度:64

contact_way

Integer

联系方式的类型。0:短信;1:邮件

最小值:0

最大值:1

area_code

String

国家码

最小长度:0

最大长度:16

x_customer_id

String

子用户id

最小长度:0

最大长度:64

customer_id

String

客户id

最小长度:0

最大长度:64

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:0

最大长度:32

error_msg

String

错误描述

最小长度:0

最大长度:32

请求示例

{
  "verify_code" : "123456",
  "contact_value" : "123456",
  "contact_way" : 1,
  "area_code" : "86",
  "x_customer_id" : "123456",
  "customer_id" : "123456"
}

响应示例

状态码

状态码

描述

200

response of 200

错误码

请参见错误码