更新时间:2024-04-28 GMT+08:00

校验客户注册信息

功能介绍

客户注册时可检查客户的登录名称、手机号或者邮箱是否可以用于注册。

针对校验手机号场景,目前仅支持校验手机号注册数量是否超过上限。

接口约束

该接口只允许使用合作伙伴AK/SK或者Token调用。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

POST /v2/partners/sub-customers/users/check-identity

请求消息

请求参数

参数

是否必选

参数类型

取值范围

描述

search_type

String

[email|mobile|name]

该字段内容可填为:“email”、“mobile”或“name”。

search_value

String

最大长度:64

手机号、邮箱或登录名称。

  • 手机号需符合正则表达式 ^\d{4}-\d+$;包括国家码,以00开头,格式:00XX-XXXXXXXX。
  • 邮箱需为含有@的正确格式的完整邮箱地址。
  • name:符合正则表达式^([a-zA-Z-]([a-zA-Z0-9_-]){4,31})$,长度5-32;不能以“op_”或“shadow_”开头且不能全为数字,且只能以字母(不区分大小写)或者-开头。

请求示例

POST https://bss-intl.myhuaweicloud.com/v2/partners/sub-customers/users/check-identity HTTP/1.1
Content-Type: application/json
X-Auth-TokenMIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ

{
  "search_type": "name", 
  "search_value": "ceshiyonghu001"
}

响应消息

响应参数

参数

参数类型

取值范围

描述

error_code

String

最大长度:16

状态码。具体请参考状态码。只有失败才会返回这个参数。

error_msg

String

最大长度:1024

错误描述信息。只有失败才会返回这个参数。

check_result

String

最大长度:32

  • available:该登录名称/手机号/邮箱有效。
  • used_by_user:该登录名称/手机号/邮箱已被占用。

响应示例

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: length
Date: response time  
{
    "error_code": "CBC.0000",
    "error_msg": "success",
    "check_result": "available"
}

状态码

  • 状态码4xx:由于明显的客户端错误(例如,格式错误的请求语法、参数错误等),华为云会返回4xx错误码,请及时检查请求消息的正确性,重新发起请求。
  • 状态码5xx:由于华为云系统原因,导致无法完成明显有效请求的处理,可及时联系华为云客服处理。

HTTP状态码

错误码

描述

400

CBC.0100

参数错误。

403

CBC.0151

访问拒绝。

500

CBC.0999

其他错误。