添加分机组

添加并配置分机组。

请求 URL

POST {base_url}/{api_path}/extensiongroup/create?access_token={access_token}

请求参数

参数 是否必填 类型 说明
name 是 String 分机组名称。
member_select 是 String 分机组成员的添加方式。

取值范围：

  • sel_all_ext：添加所有分机。
  • sel_specific：仅添加指定分机。
members 否 Array<Member_info> 成员分机的信息。
注： 仅当 member_select 设置为 sel_specific 时必填。
mgr_enb_chg_presence 适用分机组管理员 否 Integer 管理员是否可在话务控制台修改分机组成员的在线状态。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_call_distribution 适用分机组管理员 否 Integer 管理员是否可在话务控制台分配来电，包括转移、转接、拖拽等操作。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_call_conn 适用分机组管理员 否 Integer 管理员是否可在话务控制台截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_monitor 适用分机组管理员 否 Integer 管理员是否可在话务控制台监听通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_call_park 适用分机组管理员 否 Integer 管理员是否可在话务控制台停泊和取回通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ctrl_ivr 适用分机组管理员 否 Integer 管理员是否可在话务控制台控制 IVR 来电，不受 IVR 菜单限制。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ctrl_call_flow 适用分机组管理员 否 Integer 管理员是否可在话务控制台控制通话流程。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ctrl_ai_receptionist 适用分机组管理员 否 Integer 管理员是否可在话务控制台控制 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_office_time_switch 否 Integer 管理员是否可在话务控制台切换办公时间和假期状态。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_mgr_recording 适用分机组管理员 否 Integer 管理员是否可在话务控制台切换分机的录音状态。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_company_contact_match 适用分机组管理员 否 Integer 管理员是否可在话务控制台识别企业联系人的来电，即使其无权查看该联系人。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_call_distribution 适用分机组管理员 否 Integer 管理员是否可在分机页面分配来电，包括转移、转接操作。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_call_conn 适用分机组管理员 否 Integer 管理员是否可在分机页面截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_monitor 适用分机组管理员 否 Integer 管理员是否可在分机页面监听通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_call_park 适用分机组管理员 否 Integer 管理员是否可在分机页面停泊和取回通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_call_flow 适用分机组管理员 否 Integer 管理员是否可在分机页面控制通话流程。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_ai_receptionist 适用分机组管理员 否 Integer 管理员是否可在分机页面管理 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
mgr_enb_ext_company_contact_match 适用分机组管理员 否 Integer

管理员是否可在分机页面识别企业联系人的来电，即使其无权查看该联系人。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_chg_presence 适用分机组用户 否 Integer 用户是否可在话务控制台修改分机组成员的在线状态。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_call_distribution 适用分机组用户 否 Integer 用户是否可在话务控制台分配来电，包括转移、转接、拖拽等操作。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_call_conn 适用分机组用户 否 Integer

用户是否可在话务控制台截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_monitor 适用分机组用户 否 Integer 用户是否可在话务控制台监听通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_call_park 适用分机组用户 否 Integer 用户是否可在话务控制台停泊和取回通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ctrl_ivr 适用分机组用户 否 Integer 用户是否可在话务控制台控制 IVR 通话，不受 IVR 菜单限制。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ctrl_call_flow 适用分机组用户 否 Integer 用户是否可在话务控制台控制通话流程。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ctrl_ai_receptionist 适用分机组用户 否 Integer 用户是否可在话务控制台控制 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_company_contact_match 适用分机组用户 否 Integer

用户是否可在话务控制台识别企业联系人的来电，即使其无权查看企业联系人。

取值范围：
  • 0：禁用
  • 1：启用
user_enb_ext_call_distribution 适用分机组用户 否 Integer

用户是否可在分机页面分配来电，包括转移、转接操作。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ext_call_conn 适用分机组用户 否 Integer

用户是否可在分机页面截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ext_monitor 适用分机组用户 否 Integer 用户是否可在分机页面监听通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ext_call_park 适用分机组用户 否 Integer

用户是否可在分机页面停泊和取回通话。

取值范围：
  • 0：禁用
  • 1：启用
user_enb_ext_call_flow 适用分机组用户 否 Integer

用户是否可在分机页面控制通话流程。

取值范围：
  • 0：禁用
  • 1：启用
user_enb_ext_ai_receptionist 适用分机组用户 否 Integer 用户是否可在分机页面控制 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
user_enb_ext_company_contact_match 适用分机组用户 否 Integer 用户是否可通过分机页面识别企业联系人的来电，即使其无权限查看企业联系人。

取值范围：

  • 0：禁用
  • 1：启用
Member_info
注： 仅当 member_select 设置为 sel_specific 时必填。
参数 是否必填 类型 说明
ext_id 是 Integer 分机的唯一 ID。
注： 可使用 搜索特定分机 接口查询分机 ID。
role 是 String 分机在该分机组中的角色。

取值范围：

  • manager
  • user
  • custom
enb_chg_presence (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台修改分机组成员的在线状态。

取值范围：

  • 0：禁用
  • 1：启用
enb_call_distribution (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台分配来电，包括转移、转接、拖拽等操作。

取值范围：

  • 0：禁用
  • 1：启用
enb_call_conn (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_monitor (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台监听通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_call_park (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台停泊和取回通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_ctrl_ivr (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台控制 IVR 来电，不受 IVR 菜单限制。

取值范围：

  • 0：禁用
  • 1：启用
enb_ctrl_call_flow (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台控制通话流程。

取值范围：

  • 0：禁用
  • 1：启用
enb_ctrl_ai_receptionist (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台控制 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_office_time_switch (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台切换办公时间和假期状态。

取值范围：

  • 0：禁用
  • 1：启用
enb_mgr_recording (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台切换分机的录音状态。

取值范围：

  • 0：禁用
  • 1：启用
enb_company_contact_match (适用分机组自定义用户) 否 Integer 自定义用户是否可在话务控制台识别企业联系人的来电，即使其无权查看该联系人。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_call_distribution (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面分配来电，包括转移、转接操作。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_call_conn (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面截答或挂断其他分机的通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_monitor (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面监听通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_call_park (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面停泊和取回通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_call_flow (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面控制通话流程。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_ai_receptionist (适用分机组自定义用户) 否 Integer 自定义用户是否可在分机页面管理 AI 接待员的通话。

取值范围：

  • 0：禁用
  • 1：启用
enb_ext_company_contact_match (适用分机组自定义用户) 否 Integer

自定义用户是否可在分机页面识别企业联系人的来电，即使其无权查看该联系人。

取值范围：

  • 0：禁用
  • 1：启用

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。
id Integer 分机组的唯一 ID。

示例

请求示例
POST /openapi/v1.0/extensiongroup/create?access_token=auFIy0VMe5e8dYFKwUdGlozNLLOjRDaD 

Host: yeastardocs.example.yeastarcloud.com
Content-Type: application/json

{
    "name": "test", 
    "member_select": "sel_specific",
    "members": [
            {
                "ext_id": 159,
                "role": "manager"
            },
            {
                "ext_id": 10,
                "role": "user"
            },
            {
                "ext_id": 7,
                "role": "custom",
                "enb_chg_presence": 0,
                "enb_call_distribution": 0,
                "enb_call_conn": 0,
                "enb_monitor": 0,
                "enb_call_park": 1,
                "enb_ctrl_ivr": 0,
                "enb_ctrl_call_flow": 1,
               "enb_ctrl_ai_receptionist": 0,
                "enb_company_contact_match": 0,
                "enb_ext_call_distribution": 1,
                "enb_ext_call_conn": 0,
                "enb_ext_monitor": 0,
                "enb_ext_call_park": 0,
                "enb_ext_call_flow": 0,
               "enb_ext_ai_receptionist": 0,
                "enb_ext_company_contact_match": 0  
            }
    ],       
        "mgr_enb_chg_presence": 1,
        "mgr_enb_call_distribution": 1,
        "mgr_enb_call_conn": 1,
        "mgr_enb_monitor": 1,
        "mgr_enb_call_park": 1,
        "mgr_enb_ctrl_ivr": 1,
        "mgr_enb_ctrl_call_flow": 1,
        "mgr_enb_ctrl_ai_receptionist": 1,
        "mgr_enb_office_time_switch": 0,
        "mgr_enb_mgr_recording": 0,
        "mgr_enb_company_contact_match": 0,
        "mgr_enb_ext_call_distribution": 1,
        "mgr_enb_ext_call_conn": 1,
        "mgr_enb_ext_monitor": 1,
        "mgr_enb_ext_call_park": 1,
        "mgr_enb_ext_call_flow": 1,
        "mgr_enb_ext_ai_receptionist": 1,
        "mgr_enb_ext_company_contact_match": 0,
        "user_enb_chg_presence": 0,
        "user_enb_call_distribution": 0,
        "user_enb_call_conn": 0,
        "user_enb_monitor": 0,
        "user_enb_call_park": 0,
        "user_enb_ctrl_ivr": 0,
        "user_enb_ctrl_call_flow": 0,
        "user_enb_ctrl_ai_receptionist": 0,
        "user_enb_company_contact_match": 0,
        "user_enb_ext_call_distribution": 0,
        "user_enb_ext_call_conn": 0,
        "user_enb_ext_monitor": 0,
        "user_enb_ext_call_park": 0,
        "user_enb_ext_call_flow": 0,
        "user_enb_ext_ai_receptionist": 0,
        "user_enb_ext_company_contact_match": 0        
}

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "id": 306
}