Перейти до вмісту
FlySIPFlySIP Docs

Manage hot dial numbers

Цей контент ще не доступний вашою мовою.

A hot key is a single digit that a calling card caller presses instead of dialling a full number. Each key of an account stores one destination. These methods manage the Hot Key entries of the account’s Hot Keys/Smart Dialing screen; smart dials on the same screen have their own methods.

All methods support trusted mode with i_customer.

addHotDialNumber

Section titled “addHotDialNumber”

Stores a destination behind a key.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
hot_key string yes Hot Key: a digit from 0 to 9 that the account does not use yet
dest string yes Destination Phone Number
description string no Free text

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("addHotDialNumber", {"i_account": 3092, "hot_key": "1", "dest": "447700900123", "description": "Home"})
response
{"result": "OK"}

updateHotDialNumber

Section titled “updateHotDialNumber”

Changes the destination of a key.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
hot_key string yes The key to change
dest string yes New destination number

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("updateHotDialNumber", {"i_account": 3092, "hot_key": "1", "dest": "447700900456"})
response
{"result": "OK"}

delHotDialNumber

Section titled “delHotDialNumber”

Removes a key.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
hot_key string yes The key to remove

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("delHotDialNumber", {"i_account": 3092, "hot_key": "1"})
response
{"result": "OK"}

listHotDialNumbers

Section titled “listHotDialNumbers”

Lists the keys of an account.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account

Returns

Section titled “Returns”
Name Type Description
result string OK
hot_keys array Keys, each a struct with hot_key (string), dest (string, the destination number) and description (string)

Example

Section titled “Example”
request
call("listHotDialNumbers", {"i_account": 3092})
response
{
    "result": "OK",
    "hot_keys": [
        {"hot_key": "1", "dest": "447700900123", "description": "Home"},
        {"hot_key": "2", "dest": "13105550142", "description": "Office"},
    ],
}
Section titled “Related”