Skip to content

手机验证相关接口

发送手机验证码

C2S POST /bp/user/send_phone_verify_code

S2S POST /bp/server/user/send_phone_verify_code

接口功能:发送验证码

请求头部参数 (Headers):

无效用户 session_token 验证

参考接入 BytePower

  • X-BytePower-Sign:请求体签名

请求体

  • content-type: "application/json"

  • 描述:绘图所需信息

  • 参数类型

    名字类型示例是否必填描述
    phone_numberstringXXXtrue手机号
  • 请求体示例:

json
{
  "phone_number": "+8615512345678"
}

响应

  • HTTP 状态码:200

    描述:成功 响应示例:

json
{}

HTTP 状态码:4xx 描述:错误 响应示例:

json
{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type:

  • invalid_parameter(参数错误)

绑定或换绑手机号

C2S POST /bp/user/me/phone

S2S POST /bp/server/user/{user_id}/phone

请求头部参数 (Headers):

参考接入 BytePower

  • X-BytePower-Sign:请求体签名
  • X-BytePower-Session-Token:登录后获取用户的 session。

请求体

  • content-type: "application/json"

  • 描述:注册时候验证邮箱

  • 参数类型

    名字类型示例是否必填描述
    phone_numberstringXXXtrue手机号
    verify_codestringXXXXtrue验证码
  • 请求体示例:

json
{
  "phone": {
    "phone_number": "+8615512345678",
    "verify_code": "123456"
  }
}

响应

  • HTTP 状态码:200

    描述:成功 响应示例: 无

js
{
  "phone": {
    "phone_number": "+8615512345678"
  }
}

HTTP 状态码:4xx 描述:错误 响应示例:

json
{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type:

  • invalid_parameter(参数错误)

解绑手机号

C2S DELETE /bp/user/me/phone/current

S2S DELETE /bp​/server​/user​/{user_id}​/phone​/current

请求头部参数 (Headers):

参考接入 BytePower

  • X-BytePower-Sign:请求体签名
  • X-BytePower-Session-Token:登录后获取用户的 session。

请求体

响应

  • HTTP 状态码:200

    描述:登录成功 响应示例: 无

HTTP 状态码:4xx 描述:错误 响应示例:

json
{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type:

  • invalid_parameter(参数错误)
  • config_invalid (console 配置问题)

通过手机号发送验证码(供登录后的用户的使用)

C2S POST /bp/user/me/phone/current/send_verify_code

S2S POST /bp/server/user/{user_id}/phone/current/send_verify_code

请求头部参数 (Headers):

参考接入 BytePower

  • X-BytePower-Sign:请求体签名
  • X-BytePower-Session-Token:登录后获取用户的 session。

请求体

响应

  • HTTP 状态码:200

    描述:成功 响应示例: 无

HTTP 状态码:4xx 描述:错误 响应示例:

json
{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type:

  • invalid_parameter(参数错误)

验证验证码(供登录后的用户的使用)

C2S POST /bp/user/me/phone/current/validate_verify_code

S2S POST /bp/server/user/{user_id}/phone/current/validate_verify_code

请求头部参数 (Headers):

参考接入 BytePower

  • X-BytePower-Sign:请求体签名
  • X-BytePower-Session-Token:登录后获取用户的 session。

请求体

  • content-type: "application/json"

  • 描述:注册时候验证邮箱

  • 参数类型

    名字类型示例是否必填描述
    phone_numberstringXXXtrue手机号
    verify_codestringXXXXtrue验证码
  • 请求体示例:

json
{
  "verify_code": "123456"
}

响应

  • HTTP 状态码:200

    描述:成功 响应示例: 无

js
{
}

HTTP 状态码:4xx 描述:错误 响应示例:

json
{
  "error": {
    "error_type": "invalid_parameter",
    "message": "xxxxx"
  }
}

error_type:

  • invalid_parameter(参数错误)

京ICP备19011570号-2