1. References
  2. Management API
  3. SIPWhiteList
Rate this page:

SIPWhiteList

Methods

AddSipWhiteListItem

Copy URL

Adds a new network address to the SIP white list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
AddSipWhiteListItem example
Copy

AddSipWhiteListItem example

Parameters

  • description:

    string

    Optional

    The network address description

  • sip_whitelist_network:

    string

    The network address in format A.B.C.D/L or A.B.C.D/a.b.c.d (example 192.168.1.5/16)

Returns

  • result:

    number

    1

  • sip_whitelist_id:

    number

    The SIP white list item ID

DelSipWhiteListItem

Copy URL

Deletes the network address from the SIP white list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
DelSipWhiteListItem example
Copy

DelSipWhiteListItem example

Parameters

  • sip_whitelist_id:

    number

    The SIP white list item ID to delete

Returns

  • result:

    number

    1

GetSipWhiteList

Copy URL

Gets the SIP white list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
GetSipWhiteList example
Copy

GetSipWhiteList example

Get two networks, but skip the first one.

Parameters

  • count:

    number

    Optional
    Defaults on:  20

    The max returning record count

  • offset:

    number

    Optional
    Defaults on:  0

    The first N records are skipped in the output

  • sip_whitelist_id:

    number

    Optional

    The SIP white list item ID to filter

Returns

  • count:

    number

    The returned networks count

  • result:

    [SipWhiteListInfoType]

  • total_count:

    number

    The total found networks count

SetSipWhiteListItem

Copy URL

Edits the SIP white list.

Available for roles

To call this method, make sure your service account has one of the following roles:

See Available Roles
Owner
Admin
Developer
SetSipWhiteListItem example
Copy

SetSipWhiteListItem example

Parameters

  • description:

    string

    Optional

    The network address description

  • sip_whitelist_id:

    number

    The SIP white list item ID

  • sip_whitelist_network:

    string

    The new network address in format A.B.C.D/L or A.B.C.D/a.b.c.d (example 192.168.1.5/16)

Returns

  • result:

    number

    1