更新 YCM 用户的信息

更新指定 YCM 用户的信息。

请求 URL

PUT {base_url}/dm/open_api/v1/users/{userId}

请求参数

路径参数
参数 是否必填 类型 说明
userId 是 Long YCM 用户 ID。
请求头
参数 是否必填 类型 说明
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 说明
company 否 String 公司名称。
firstName 否 String 名称。
lastName 否 String 姓氏。
email 否 String 邮箱。
phone 否 String 电话号码。
mobile 否 String 手机号码。
address 否 String 地址。
remark 否 String 备注。
twoFactorAuthenticationEnable 否 String 是否禁用此用户账号的双因素身份验证功能。
pbxCreationLimit 否 Integer 经销商可拥有的云 PBX 最大数量，包括用户自行创建的 PBX，以及你为其创建的 PBX。
注：
  • 此参数仅对经销商有效。可使用 查询指定 YCM 用户 接口查询用户类型。
  • 若无需限制，将此参数设置为空 ("")。
  • 若需限制，此参数值必须大于或等于经销商当前已拥有的云 PBX 数量，且不能为 0。

响应参数

参数 类型 说明
requestId String 请求 ID，作为该请求的唯一标识，用于快速定位请求。
status String 请求结果。
  • Success：请求成功。
  • Failed：请求失败。
time Long 请求响应的时间。
注： YCM API 响应返回的是时间戳，如有需要，你可以将时间戳转换成具体的日期和时间。详细操作方法，请参见 将时间戳转换为日期和时间。

示例

请求示例

更新 YCM 用户 (ID：13329) 的公司名称信息。
PUT /dm/open_api/v1/user/13329 HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0Mzc2MjB9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDM5NDIwLCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiI4Y2MyNTcwNS0yZjg1LTQ1NzctOWFmYy00NjllZGJmN2Y0ODUiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.6V-WgKLIpGYY-nvmRCqUXmrKvN9ajk8nBBzzw7Jv82s
Content-Type: application/json
{  
  "company": "New Company Name"
}
响应示例
HTTP/1.1 200 OK
{
  "requestId": "bed793ceb96f19a58177b53a3097a1d8",
  "status": "Success",
  "time": 1664437503
}