更新会议账号

更新时间: 2024/08/16 14:25:00

通过该接口修改一个会议账号的信息。

请求信息

  • 请求方法:POST
  • 请求 URL:https://meeting.yunxinroom.com/scene/meeting/api/v2/update-user HTTP/1.1
  • Content-Type:application/json;charset=utf-8
  • AppKey:应用的 AppKey。详情请参考 创建应用并获取 AppKey
  • 鉴权头:接口鉴权。详情请参考 请求结构

请求头参数

请求头(Header)的参数说明,请参考 请求结构

请求体参数

名称 类型 是否必选 说明

userUuid

String

用户账号。

  • 支持最长 32 个字符。
  • 支持小写英文和数字。
  • 支持四个特殊字符(_ @ . -)。
name String 用户名称,即账号使用者的姓名、称呼、昵称等,最多支持 30 个非空字符。
shortMeetingNum String 企业内个人会议短号,支持 4 到 8 位数字。
sipCid String 企业内 SIP 号,支持 1 到 16 位数字。
avatar String 存储头像图案的 URL,支持 10 到 255 个标准 URI 字符,标准参考 RFC 3986。
phoneNumber String 手机号码。例如 13912341234,目前仅支持中国大陆地区手机号码。
email String 邮箱地址。

departments

JsonArray

用户所在的一个或多个部门的路径。

  • 最多支持 20 层分级。
  • 部门名称支持汉字、数字、英文字母。
  • 不同的部门名称之间用半角逗号(,)或反斜杠符号(/)分隔。
  • 每一个账户仅支持设置一个部门。即数组元素最多为 1。
  • 示例:
    • ["一级部门 1/二级部门 1"]
    • ["销售部门,杭州分部"]

请求体示例

JSON{
    "userUuid": "user_uuid_sample",
    "name": "SomeoneName",
    "privateMeetingNum": "private_meeting_number_sample",
    "shortMeetingNum": "short_meeting_number_sample",
    "sipCid": "sip_cid_sample",
    "avatar": "https://sample.com/sample_url_path",
    "phoneNumber": "13912341234",
    "email": "someone@example.com",
    "departments":["一级部门,二级部门"]
}

响应信息

响应参数

以下是返回结果(Body)中 data 属性内包含的参数。有关统一返回参数的说明,请参考 返回结果

名称 类型 说明
userUuid String 用户账号。
userToken String 用户账号登录令牌。
name String 用户名称,即账号使用者的姓名,称呼,昵称等。
privateMeetingNum String 个人会议唯一号,全局唯一。
shortMeetingNum String 个人会议短号。
sipCid String 企业内 SIP 号,支持 1 到 16 位数字。
avatar String 存储头像图案的 URL。
phoneNumber String 手机号码。
email String 邮箱地址。

state

Integer

  • 1:启用。
  • 2:禁用。 注销账号即删除账号,没有对应状态。
departments JsonArray 部门路径列表。

响应体示例

JSON{
    "userUuid": "user_uuid_sample",
    "userToken": "user_token_sample",
    "name": "someone_name",
    "privateMeetingNum": "private_meeting_number_sample",
    "shortMeetingNum": "short_meeting_number_sample",
    "sipCid": "sip_cid_sample",
    "avatar": "https://sample.com/sample_url_path",
    "phoneNumber": "13912341234",
    "email": "someone@example.com",
    "state": 1,
    "departments":["/销售部门/杭州分部"]
}

错误码

详情请参考 错误码

此文档是否对你有帮助?
有帮助
去反馈
  • 请求信息
  • 请求头参数
  • 请求体参数
  • 请求体示例
  • 响应信息
  • 响应参数
  • 响应体示例
  • 错误码