SIGN UP

Managing SIP white list

Methods

Adds a new network address to the SIP white list.

Parameters

  • Follow link for authentication parameter names and details.

  • 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.

Examples

request:

https://api.voximplant.com/platform_api/AddSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_network=192.168.1.5%2F16

response:

{
    "result": 1,
    "sip_whitelist_id": 1
}

Deletes the network address from the SIP white list.

Parameters

  • account_id:

    number

    The account's ID.

  • api_key:

    string
  • sip_whitelist_id:

    number

    The SIP white list item ID to delete.

Returns

  • result:

    number

    1

Examples

request:

https://api.voximplant.com/platform_api/DelSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_id=1

response:

Success.

{
    "result": 1
}

Gets the SIP white list.

Parameters

  • Follow link for authentication parameter names and details.

  • sip_whitelist_id:

    number

    The SIP white list item ID to filter

  • count:

    numberDefaults to 20

    The max returning record count.

  • offset:

    numberDefaults to 0

    The first N records will be skipped in the output.

Returns

  • total_count:

    number

    The total found networks count.

  • count:

    number

    The returned networks count.

Examples

request:

Get two networks, but skip the first one.

https://api.voximplant.com/platform_api/GetSipWhiteList/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2

response:

{
    "count": 2,
    "result": [
        {
            "sip_whitelist_id": 12,
            "sip_whitelist_network": "192.168.15.1\/24"
        },
        {
            "sip_whitelist_id": 33,
            "sip_whitelist_network": "192.168.16.1\/24"
        }
    ],
    "total_count": 7
}

Edits the SIP white list.

Parameters

  • Follow link for authentication parameter names and details.

  • 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

Examples

request:

https://api.voximplant.com/platform_api/SetSipWhiteListItem/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&sip_whitelist_id=1&sip_whitelist_network=192.168.1.5%2F16

response:

Success.

{
    "result": 1
}