Перейти к содержимому
FlySIPFlySIP Docs

Manage trunks

Это содержимое пока не доступно на вашем языке.

A trunk delivers calls aimed at an account to the account’s own equipment, such as a PBX, instead of to the registered account. It works like a vendor connection, but belongs to an account. A trunk has one or more destinations, managed with the trunk connection methods; incoming routes decide which calls use the trunk. These methods do the same as the Trunks screen of an account.

All methods support trusted mode with i_customer.

Trunk structure

Section titled “Trunk structure”
Name Type Description
i_trunk int ID of the trunk
i_account int Account the trunk belongs to
name string Name, up to 64 characters in the panel
description string Description
policy string Order in which the trunk’s connections are tried: ordered (default, by their order) or round-robin

createTrunk

Section titled “createTrunk”

Creates a trunk for an account.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
name string yes Name of the trunk
description string no Free text
policy string no ordered (default) or round-robin

Returns

Section titled “Returns”
Name Type Description
result string OK
i_trunk int ID of the new trunk

Example

Section titled “Example”
request
call("createTrunk", {"i_account": 3092, "name": "PBX", "description": "Office PBX"})
response
{"result": "OK", "i_trunk": 52}

updateTrunk

Section titled “updateTrunk”

Changes a trunk. Send only the fields you change.

Parameters

Section titled “Parameters”
Name Type Required Description
i_trunk int yes ID of the trunk
name string no New name
description string no Free text
policy string no ordered or round-robin

The account of a trunk cannot be changed.

Returns

Section titled “Returns”
Name Type Description
result string OK
i_trunk int ID of the trunk

Example

Section titled “Example”
request
call("updateTrunk", {"i_trunk": 52, "policy": "round-robin"})
response
{"result": "OK", "i_trunk": 52}

deleteTrunk

Section titled “deleteTrunk”

Deletes a trunk. The panel deletes the trunk’s connections with deleteTrunkConnection first; do the same.

Parameters

Section titled “Parameters”
Name Type Required Description
i_trunk int yes ID of the trunk

Returns

Section titled “Returns”
Name Type Description
result string OK
i_trunk int ID of the deleted trunk

Example

Section titled “Example”
request
call("deleteTrunk", {"i_trunk": 52})
response
{"result": "OK", "i_trunk": 52}

getTrunkInfo

Section titled “getTrunkInfo”

Returns one trunk.

Parameters

Section titled “Parameters”
Name Type Required Description
i_trunk int yes ID of the trunk

Returns

Section titled “Returns”
Name Type Description
result string OK
trunk struct The trunk, with the fields of the structure

Example

Section titled “Example”
request
call("getTrunkInfo", {"i_trunk": 52})
response
{
    "result": "OK",
    "trunk": {
        "i_trunk": 52,
        "i_account": 3092,
        "name": "PBX",
        "description": "Office PBX",
        "policy": "ordered",
    },
}

getTrunksList

Section titled “getTrunksList”

Lists the trunks of an account.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
name_pattern string no Only trunks whose name matches this case-insensitive SQL LIKE pattern: % matches any characters, _ one character
offset int no Skip this many trunks
limit int no Return at most this many trunks

Returns

Section titled “Returns”
Name Type Description
result string OK
trunks array Trunks, each a struct with the fields of the structure

Example

Section titled “Example”
request
call("getTrunksList", {"i_account": 3092, "name_pattern": "%pbx%"})
response
{
    "result": "OK",
    "trunks": [
        {"i_trunk": 52, "i_account": 3092, "name": "PBX",
         "description": "Office PBX", "policy": "ordered"},
    ],
}
Section titled “Related”