创建 YCM 用户

创建 YCM 用户。

请求 URL

POST {base_url}/dm/open_api/v1/users

请求参数

请求头
参数 是否必填 类型 描述
Authorization 是 String 在请求头中传递访问 Token。

格式：Bearer {access_token}。
请求体
参数 是否必填 类型 描述
userType 是 String 指定用户类型。
取值范围：
  • My Colleague：我的同事
  • Hosting User：托管用户
company 否 String 公司名称。
注： 此参数在创建托管用户时必填。
firstName 是 String 名称。
lastName 否 String 姓氏。
email 是 String 邮箱。
phone 否 String 电话号码。
mobile 否 String 手机号码。
address 否 String 地址。
remark 否 String 备注。
云 PBX 套餐包
totalExtensions 是 Integer 总的分机数。
totalConcurrentCalls 是 Integer 总的并发数。
totalRecordings 是 Integer 总的通话录音分钟数。
minimumExtPerPBX 是 Integer 每台 PBX 最小分机数。
highAvailability 否 String 是否启用高可用服务。
取值范围：
  • subscribed：启用
  • unsubscribed：禁用

响应参数

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

示例

请求示例

为同事创建一个账号。

POST /dm/open_api/v1/users HTTP/1.1
Host: ycm.yeastar.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjdXN0b21Kd3RQYXlsb2FkSW5mbyI6eyJncmFudFR5cGUiOiJjbGllbnRfY3JlZGVudGlhbHMiLCJ5c0lkIjoxNzg5NjM2MDM5MDg1MDI1NzM0OSwidmVyc2lvbiI6MTYzODk1OTkwOSwicmVmcmVzaFZlcnNpb24iOjE2NjQ0MzYwNzV9LCJzY29wZSI6WyJhbGwiXSwiZXhwIjoxNjY0NDM3ODc1LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiIwZDM2NTI2Yi0yMTQ3LTRiMGQtYTg0MS1jMDFlMzVjYjE0ZmIiLCJjbGllbnRfaWQiOiJrcDl5eW50bXVlc3VrNWpvV3ZNa1RiQ0J4cU82TEtSaCJ9.yU-GTl59gDP_ayXebJ8EkoX5DtOqZH7QP5ygYOtrwyg
Content-Type: application/json
{
  "userType": "My Colleague",
  "firstName": "Malinda",
  "email": "malinda@example.com",  
  "mobile": 13811112222
}
响应示例
HTTP/1.1 200 OK
{
    "data": {
        "userId": 13856
    },
    "requestId": "e8bf12d614215281aba0084545a605f0",
    "status": "Success",
    "time": 1666071768
}