注册新用户
拥有此API的权限集 |
---|
用户管理-增删改 |
请求方式及url
- 请求方式:
POST
- 请求头:
Content-Type:application/json
- 接口地址:
https://api.xiaoe-tech.com/xe.user.register/1.0.0
- 频率限制:
10秒5000次
在线调试工具
请求
响应
请求参数说明
参数名 | 必选 | 类型 | 说明 | 备注(示例) |
---|---|---|---|---|
access_token | 是 | string | 专属token | xxxxxxxx |
data | 是 | array | 用户信息 | `` |
data.wx_union_id | 否 | string | 微信 union_id | |
data.phone | 否 | string | 联系方式 | 手机号格式:[+区号-]手机号,海外手机号区号必传,如 +1-643xxxx |
data.sdk_user_id | 否 | string | sdk用户id | |
data.sdk_app_id | 否 | string | sdk_app_id | |
data.avatar | 否 | string | 用户头像链接 | |
data.nickname | 否 | string | 微信 用户昵称 | |
data.country | 否 | string | 国家 | |
data.province | 否 | string | 省份 | |
data.city | 否 | string | 城市 | |
data.gender | 否 | int | 性别 | 0-无 1-男 2-女 |
data.wx_name | 否 | string | 真实姓名 | |
data.company | 否 | string | 公司 | |
data.industry | 否 | string | 行业 | |
data.job | 否 | string | 工作 | - |
data.wx_email | 否 | string | 邮箱 | - |
备注
- 请求时,业务数据必须包含在data下
- wx_union_id、phone、sdk_user_id至少有一个,且wx_union_id和phone不可以同时传
- 当传
sdk_user_id
时必传sdk_app_id
- 非必选的参数不要传空字符
请求示例
{
"access_token" : "xxxxxxxx",
"data" : {
"wx_union_id" : "XXXXXXXXXXXX",
"phone" : "136XXXXXXXX",
"avatar" : "XXXXXXXXXXXXXXXX",
"nickname" : "小鹅",
"gender" : 0,
"city" : "深圳",
"province" : "广东",
"country" : "中国",
"wx_name" : "张三",
"company" : "小鹅通",
"industry" : "在线教育",
"job" : "销售"
}
}
响应参数说明
参数名 | 必选 | 类型 | 说明 | 备注 |
---|---|---|---|---|
code | 是 | int | 请求结果码 | 请求成功返回0,请求失败错误码请查看错误码描述说明 |
msg | 是 | string | 描述信息 | 无 |
data | 是 | class | 数据 | 无 |
data.user_id | 是 | string | 小鹅通用户id | 无 |
data.user_exists | 是 | int | 用户状态 | 0-新注册用户;1-用户手机号存在;2-用户union_id存在 |
响应示例
{
"code": 0,
"msg":'ok',
"data": {
"user_id": "u_xxxxxxxxxxxxxxxxxxxxx",
"user_exists": 0
}
}
返回码说明
code=0
时,表示正常code=2501
时,表示必选字段缺失code=2502
时,表示字段格式无效code=2504
时,表示用户手机号重复
特别说明: 当账号发生合并时,可能会导致API注册的账号被注销,user_id将会无效。建议接入账号合并消息推送