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

Manage Follow Me

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

Follow Me forwards calls to an account to a list of other numbers, tried in order. The mode decides when forwarding happens; the entries are the numbers. These methods do the same as the Follow Me screen of an account. The account must have Follow Me turned on (followme_enabled in createAccount or updateAccount).

All methods support trusted mode with i_customer.

Follow Me modes

Section titled “Follow Me modes”
i_followme_mode Name Calls are forwarded
1 Always Always
2 On Unavailable When the account cannot be reached
3 Off Never
4 On Busy When the account is busy
5 On No Answer When the account does not answer within followme_timeout
6 On Unregistered When the account is not registered

Follow Me entry structure

Section titled “Follow Me entry structure”
Name Type Description
i_followme_entry int ID of the entry
cld string Phone Number/CLD: the number to forward to
preference int Order Preference: position in the list, 1 is tried first
timeout int Timeout, sec: how long this number rings before the next is tried. 5 to 60, default 15
description string Free text

getFollowMeOptions

Section titled “getFollowMeOptions”

Returns the Follow Me mode and timeout 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
i_followme_mode int Mode
followme_mode_name string Name of the mode
followme_timeout int Seconds the account rings before the call is forwarded, used by modes 2 and 5

Example

Section titled “Example”
request
call("getFollowMeOptions", {"i_account": 3092})
response
{
    "result": "OK",
    "i_followme_mode": 5,
    "followme_mode_name": "On No Answer",
    "followme_timeout": 20,
}

setFollowMeOptions

Section titled “setFollowMeOptions”

Changes the Follow Me mode or timeout of an account.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
i_followme_mode int no Mode
followme_timeout int no Seconds the account rings before the call is forwarded

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("setFollowMeOptions", {"i_account": 3092, "i_followme_mode": 5, "followme_timeout": 20})
response
{"result": "OK"}

listFollowMeEntries

Section titled “listFollowMeEntries”

Lists the numbers of an account in order.

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
followme_entries array Entries, each a struct with the fields of the structure

Example

Section titled “Example”
request
call("listFollowMeEntries", {"i_account": 3092})
response
{
    "result": "OK",
    "followme_entries": [
        {"i_followme_entry": 77, "cld": "447700900123", "preference": 1,
         "timeout": 15, "description": "Mobile"},
        {"i_followme_entry": 78, "cld": "1001", "preference": 2,
         "timeout": 30, "description": "Office"},
    ],
}

addFollowMeEntry

Section titled “addFollowMeEntry”

Adds a number to the list.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
cld string yes Number to forward to
preference string no last (default), first, or a position number. Entries at and after that position move down
timeout int no Ring time of this number in seconds
description string no Free text

Returns

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

Example

Section titled “Example”
request
call("addFollowMeEntry", {"i_account": 3092, "cld": "447700900123", "timeout": 15, "description": "Mobile"})
response
{"result": "OK", "i_followme_entry": 77}

updateFollowMeEntry

Section titled “updateFollowMeEntry”

Changes a number or moves it in the list.

Parameters

Section titled “Parameters”
Name Type Required Description
i_account int yes ID of the account
i_followme_entry int yes ID of the entry
cld string no New number
preference string no first, last, up (one place earlier), down (one place later), or a position number
timeout int no Ring time in seconds
description string no Free text

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("updateFollowMeEntry", {"i_account": 3092, "i_followme_entry": 78, "preference": "first"})
response
{"result": "OK"}

deleteFollowMeEntry

Section titled “deleteFollowMeEntry”

Removes a number from the list.

Parameters

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

Returns

Section titled “Returns”
Name Type Description
result string OK

Example

Section titled “Example”
request
call("deleteFollowMeEntry", {"i_account": 3092, "i_followme_entry": 78})
response
{"result": "OK"}
Section titled “Related”