IM即时通讯

注册用户

URL

https://sdk.cloudroom.com/im/v1/user/register

请求方式:POST

请求参数

公共参数

接口参数

名称 类型 是否必传 说明
CustomUserID String 否 自定义的用户 ID,支持下划线、大小写英文字母与数字的组合,最大长度 64 字节。
Nickname String 否 用户昵称
FaceURL String 否 用户头像 URL,长度上限 255 位字符

返回参数

名称 类型 说明
RspCode Int 响应码
RspDesc String 响应描述
Data Object 数据对象

Data数据详情

名称 类型 说明
userid String IM用户ID

示例

请求示例

curl -X POST https://sdk.cloudroom.com/im/v1/user/register \
  -H "Content-Type: application/json" \
  -d '{
    "RequestId": "2d95a5fe-a384-5dea-0d84-db153b10ee0f",
    "CompID": "1111111",
    "SecretKey": "b7febff6a21c36fb50150f88c95ef641",
    "Nickname": "imTest",
    "FaceURL": "https://test.com/avatars/user_12345.png"
  }'

返回示例

{
    "RspCode": 0,
    "RspDesc": "请求成功",
    "Data": {
        "userid": "demo_test1"
    }
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码,状态码详情请参见 状态码