Add an Extension Group

Add and configure an extension group.

Request URL

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

Request parameters

Parameter Required Type Description
name Yes String Extension group name.
member_select Yes String How extensions are added to the group.

Valid value:

  • sel_all_ext: Select all extensions.
  • sel_specific: Select specific extensions.
members No Array<Member_info> The information of the member extensions.
Note: This parameter is required when member_select is set to sel_specific.
mgr_enb_chg_presence Available for manager No Integer Whether managers can change group members' presence status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_call_distribution Available for manager No Integer Whether managers can distribute incoming calls on Operator Panel, including redirect, transfer, and drag-and-drop operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_call_conn Available for manager No Integer Whether managers can pick up or hang up other extensions' calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_monitor Available for manager No Integer Whether managers can monitor calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_call_park Available for manager No Integer Whether managers can park and retrieve calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ctrl_ivr Available for manager No Integer Whether managers can control IVR calls on Operator Panel, regardless of the IVR menu.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ctrl_call_flow Available for manager No Integer Whether managers can control call flow on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ctrl_ai_receptionist Available for manager No Integer Whether managers can manage AI receptionist calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_office_time_switch Available for manager No Integer Whether managers can switch Business Hours and Holidays status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_mgr_recording Available for manager No Integer Whether managers can change group members' recording status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_company_contact_match Available for manager No Integer Whether managers can identify incoming calls from company contacts on Operator Panel, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_call_distribution Available for manager No Integer Whether managers can distribute incoming calls on Extension Page, including redirect and transfer operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_call_conn Available for manager No Integer Whether managers can pick up or hang up other extensions' calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_monitor Available for manager No Integer Whether managers can monitor calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_call_park Available for manager No Integer Whether managers can park and retrieve calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_call_flow Available for manager No Integer Whether managers can control call flow on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_ai_receptionist Available for manager No Integer Whether managers can manage AI receptionist calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
mgr_enb_ext_company_contact_match Available for manager No Integer

Whether managers can identify incoming calls from company contacts on Extension Page, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_chg_presence Available for user No Integer Whether users can change group members' presence status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_call_distribution Available for user No Integer Whether users can distribute incoming calls on Operator Panel, including redirect, transfer, and drag-and-drop operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_call_conn Available for user No Integer

Whether users can pick up or hang up other extensions' calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_monitor Available for user No Integer Whether users can monitor calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_call_park Available for user No Integer Whether users can park and retrieve calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ctrl_ivr Available for user No Integer Whether users can control IVR calls on Operator Panel, regardless of the IVR menu.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ctrl_call_flow Available for user No Integer Whether users can control call flow on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ctrl_ai_receptionist Available for user No Integer Whether users can manage AI receptionist calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_company_contact_match Available for user No Integer

Whether users can identify incoming calls from company contacts on Operator Panel, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_call_distribution Available for user No Integer

Whether users can distribute incoming calls on Extension Page, including redirect and transfer operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_call_conn Available for user No Integer

Whether users can pick up or hang up other extensions' calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_monitor Available for user No Integer Whether users can monitor calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_call_park Available for user No Integer

Whether users can park and retrieve calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_call_flow Available for user No Integer

Whether users can control call flow on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_ai_receptionist Available for user No Integer Whether users can manage AI receptionist calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
user_enb_ext_company_contact_match Available for user No Integer Whether users can identify incoming calls from company contacts on Extension Page, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled
Member_info
Note: This parameter is required when member_select is set to sel_specific.
Parameter Required Type Description
ext_id Yes Integer Extension ID.
Note: You can query extension's ID using Search Specific Extensions.
role Yes String The extension user's role in the extension group.

Valid value:

  • manager
  • user
  • custom
enb_chg_presence (Available for custom user) No Integer Whether custom users can change group members' presence status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_call_distribution (Available for custom user) No Integer Whether custom users can distribute incoming calls on Operator Panel, including redirect, transfer, and drag-and-drop operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_call_conn (Available for custom user) No Integer Whether custom users can pick up or hang up other extensions' calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_monitor (Available for custom user) No Integer Whether custom users can monitor calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_call_park (Available for custom user) No Integer Whether custom users can park and retrieve calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ctrl_ivr (Available for custom user) No Integer Whether custom users can control IVR calls on Operator Panel, regardless of the IVR menu.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ctrl_call_flow (Available for custom user) No Integer Whether custom users can control call flow on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ctrl_ai_receptionist (Available for custom user) No Integer Whether custom users can manage AI receptionist calls on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_office_time_switch (Available for custom user) No Integer Whether custom users can switch Business Hours and Holidays status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_mgr_recording (Available for custom user) No Integer Whether custom users can change group members' recording status on Operator Panel.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_company_contact_match (Available for custom user) No Integer Whether custom users can identify incoming calls from company contacts on Operator Panel, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_call_distribution (Available for custom user) No Integer Whether custom users can distribute incoming calls on Extension Page, including redirect and transfer operations.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_call_conn (Available for custom user) No Integer Whether custom users can pick up or hang up other extensions' calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_monitor (Available for custom user) No Integer Whether custom users can monitor calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_call_park (Available for custom user) No Integer Whether custom users can park and retrieve calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_call_flow (Available for custom user) No Integer Whether custom users can control call flow on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_ai_receptionist (Available for custom user) No Integer Whether custom users can manage AI receptionist calls on Extension Page.

Valid value:

  • 0: Disabled
  • 1: Enabled
enb_ext_company_contact_match (Available for custom user) No Integer

Whether custom users can identify incoming calls from company contacts on Extension Page, regardless of whether they have permission to view the company contacts.

Valid value:

  • 0: Disabled
  • 1: Enabled

Response parameters

Parameter Type Description
errcode Integer Returned error code.
  • 0: Succeed.
  • Non-zero value: Failed.
Note: You can check the error code and error message in Error Code and Error Message.
errmsg String Returned message.
  • SUCCESS: Succeed.
  • FAILURE: Failed.
id Integer The unique ID of the extension group.

Examples

Request example

POST /openapi/v1.0/extensiongroup/create?access_token=auFIy0VMe5e8dYFKwUdGlozNLLOjRDaD 
Host: 192.168.5.150:8088
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        
}

Response example

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