bindUid

将client_id与uid绑定

1. uid泛指用户的唯一标识或设备的唯一标识，可以是任何唯一标识的值；如用户ID，用户名，手机号，邮箱，微信ID，设备ID等
2. uid与client_id是一对多的关系，允许多个client_id绑定一个uid
3. client_id与uid是一对一的关系，一个client_id只能绑定一个uid，多次绑定以最后一次结果为准
4. 如果业务需要一对一关系，可以使用 getClientIdByUid 获取UID已绑定的client_id列表， 再使用 unbindUid 解绑，或者使用 closeClient 关闭该client_id
5. client_id下线，会自动解绑uid，无需手动 unbindUid 解绑

提示

• 绑定成功后，可以通过 sendToUid 发送消息给指定用户UID
• 绑定成功后，可以通过 isUidOnline 判断用户UID是否在线
• 绑定成功后，可以通过 setUidSession 设置用户UID的会话Session
• 绑定成功后，可以通过 getUidSession 获取用户UID的会话Session
• 绑定成功后，可以通过 rpc 对指定的UID调用RPC，返回结果值新特性

接口URL

/api/bindUid

请求方式

POST

Content-Type

application/json;charset=utf-8

请求Header参数

普通模式（Token验证）

默认，服务运行于普通模式，请求携带Header参数：

参数名	类型	描述
Token	string	认证Token，即 config.json 文件中的Token

安全模式（签名验证）

可指定启动参数 -s=true，将服务运行于安全模式，请求携带Header参数：

参数名	类型	描述
Timestamp	int	请求毫秒时间戳
Signature	string	请求签名值签名算法

请求Body参数

参数名	类型	是否必填	描述
auth	string	是	长连接认证字符串
client_id	string	是	客户端ID
uid	string	是	用户UID

请求Body示例

{
  "auth": "a023de54011dcaa459bbbd5bc72f275b",
  "client_id": "cd94421e-7e38-4370-bf82-b1b6ff142db5",
  "uid": "1"
}

响应示例

成功

{
  "code": 0,
  "message": "成功"
}

失败

{
  "code": 104,
  "message": "客户端不在线或不存在"
}

{
  "code": 105,
  "message": "认证失败，auth不匹配"
}