Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

You can test API methods on the interactive API browser page and without writing code
Some of the resources described on the page may not be available by default due to the type of application (see Creating and authorizing applications).

This resource is intended to differentiate the possibilities to manage current calls from a telephone terminal: pickup, whisper, eavesdrop. Absence of rules implies the ability to pick up a call within the entire PBX and to prohibit any other actions.  

Description of Data Structures 

 CallControlPermissions

Name 

Type 

Description 

allow_all 

boolean 

Allows globally any actions if true (everyone can intercept and listen to everyone) 

pickup_all 

boolean 

Ability to pick up calls within the entire PBX (if the value is false, pickup is possible only within pickup_share_groups). The default value is true. 

groups 

Object 

Contains a simple listing of groups with the names of extensions numbers that may be in different groups. There can be no more than 100 groups, each of which contains no more than 200 extension numbers (their existence is not checked) 

pickup_share_groups 

array 

Groups, which interception is possible within without specifying an extension number. When "pickup_all": false, the pickup is possible only within groups. If an extension number is included to several pickup groups and the pickup takes place on its behalf, the groups are combined into one group 

eavesdrop_{ext} 

array 

Where the suffix "ext" is the extension number name: the groups that the ext extension number can listen to. If no such group is found, then the action is prohibited. 

whisper_{ext} 

array 

Where the suffix "ext" is the extension number name: the groups that the ext"extension number can whisper to. If no such group is found, then the action is prohibited. 

Example 

Create pickups: 

  • “100": the pickup is possible without specifying the extension numbers "102", "101" and with specifying all the other numbers ("pickup_all": true);

  • “101": the pickup is possible without specifying the extension numbers "102", "100" and with specifying all the other numbers ("pickup_all": true);

  • "102": the pickup is possible without specifying the extension numbers "101", "100" and with specifying all the other numbers ("pickup_all": true);

Listening: "101" may listen to the groups "sales", "hr" (the extension numbers "102", "100"). No other PBX extension numbers has the permission to listen to the calls. 

Hint: "100" can connect to the dialogue in the hint mode to the extension numbers of the "support" group ("101"). 

System response: 

 Expand
{
  "allow_all": false,
  "pickup_all": true,
  "groups": {
    "support": [
      "100",
      "101"
    ],
    "sales": [
      "102",
      "101"
    ],
    "hr": [
      "100",
      "101",
      "103"
    ]
  },
  "pickup_share_groups": [
    "support",
    "sales"
  ],
  "eavesdrop_100": [
    "support"
  ],
  "whisper_101": [
    "sales",
    "hr"
  ]
}

"Client" Section Resources 

 PUT /client/{client_id}/call_control_group/

PUT /client/{client_id}/call_control_group/ 

URL Options 

Name 

Type 

client_id 

string 

JSON Options 

Name 

Type 

call_control_groups  

string 

 GET /client/{client_id}/call_control_group/

GET /client/{client_id}/call_control_group/ 

URL Options 

Name 

Type 

client_id 

string 

  • No labels