v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

User Groups

Update group

Use the Update group API request if you want to update one of the settings from a user group. You should send the user group id as a variable and fields you want to update in the request body:

Request Body

name (string): The name of the group.
description (string): Description of the group.
callerid_name (string): Caller ID name for the group.
callerid_number (string): Caller ID number for the group.
ratio (string): Ratio for the group.
freeswitch (string): FreeSwitch details for the group.
hard_drop_rate (string): Hard drop rate for the group.
soft_drop_rate (string): Soft drop rate for the group.
optimal_drop_rate (string): Optimal drop rate for the group.
hard_ratio_increment (string): Hard ratio increment for the group.
soft_ratio_increment (string): Soft ratio increment for the group.
optimal_ratio_increment (string): Optimal ratio increment for the group.
group_type (string): Type of the group.
minimum_ratio (string): Minimum ratio for the group.
maximum_ratio (string): Maximum ratio for the group.

Response

The API returns a JSON object with a groups key, which contains an array of group objects. In the example response.

put/groups/{id}

Request body

callerid_namestring

callerid_numberstring

descriptionstring

freeswitchstring

group_typestring

hard_drop_ratestring

hard_ratio_incrementstring

maximum_ratiostring

minimum_ratiostring

namestring

optimal_drop_ratestring

optimal_ratio_incrementstring

ratiostring

soft_drop_ratestring

soft_ratio_incrementstring

Example request

{
  "callerid_name": "string",
  "callerid_number": "string",
  "description": "string",
  "freeswitch": "string",
  "group_type": "string",
  "hard_drop_rate": "float",
  "hard_ratio_increment": "float",
  "maximum_ratio": "float",
  "minimum_ratio": "float",
  "name": "string",
  "optimal_drop_rate": "float",
  "optimal_ratio_increment": "float",
  "ratio": "float",
  "soft_drop_rate": "float",
  "soft_ratio_increment": "float"
}

Response

Successful operation

Example response

{
  "groups": []
}