Skip to content

Latest commit

 

History

History
234 lines (162 loc) · 8.86 KB

ManagingSIPWhiteListApi.md

File metadata and controls

234 lines (162 loc) · 8.86 KB
Raw

Voximplant\ManagingSIPWhiteListApi

All URIs are relative to https://api.voximplant.com/platform_api/

Method HTTP request Description
addSipWhiteListItem POST /AddSipWhiteListItem
delSipWhiteListItem POST /DelSipWhiteListItem
getSipWhiteList POST /GetSipWhiteList
setSipWhiteListItem POST /SetSipWhiteListItem

addSipWhiteListItem

\Voximplant\Model\AddSipWhiteListItemAPIResponse addSipWhiteListItem($sip_whitelist_network)

Adds a new network address to the SIP white list.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');
// Configure API key authorization: account_name
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('account_name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('account_name', 'Bearer');

$api_instance = new Voximplant\Api\ManagingSIPWhiteListApi();
$sip_whitelist_network = "sip_whitelist_network_example"; // 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).

try {
    $result = $api_instance->addSipWhiteListItem($sip_whitelist_network);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagingSIPWhiteListApi->addSipWhiteListItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
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).

Return type

\Voximplant\Model\AddSipWhiteListItemAPIResponse

Authorization

api_key, account_name

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delSipWhiteListItem

\Voximplant\Model\ActivateCallerIDAPIResponse delSipWhiteListItem($sip_whitelist_id)

Deletes the network address from the SIP white list.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');
// Configure API key authorization: account_name
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('account_name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('account_name', 'Bearer');

$api_instance = new Voximplant\Api\ManagingSIPWhiteListApi();
$sip_whitelist_id = 3.4; // float | The SIP white list item ID to delete.

try {
    $result = $api_instance->delSipWhiteListItem($sip_whitelist_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagingSIPWhiteListApi->delSipWhiteListItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
sip_whitelist_id float The SIP white list item ID to delete.

Return type

\Voximplant\Model\ActivateCallerIDAPIResponse

Authorization

api_key, account_name

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSipWhiteList

\Voximplant\Model\GetSipWhiteListAPIResponse getSipWhiteList($sip_whitelist_id, $count, $offset)

Gets the SIP white list.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');
// Configure API key authorization: account_name
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('account_name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('account_name', 'Bearer');

$api_instance = new Voximplant\Api\ManagingSIPWhiteListApi();
$sip_whitelist_id = 3.4; // float | The SIP white list item ID to filter
$count = 3.4; // float | The max returning record count.
$offset = 3.4; // float | The record count to omit.

try {
    $result = $api_instance->getSipWhiteList($sip_whitelist_id, $count, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagingSIPWhiteListApi->getSipWhiteList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
sip_whitelist_id float The SIP white list item ID to filter [optional]
count float The max returning record count. [optional]
offset float The record count to omit. [optional]

Return type

\Voximplant\Model\GetSipWhiteListAPIResponse

Authorization

api_key, account_name

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setSipWhiteListItem

\Voximplant\Model\ActivateCallerIDAPIResponse setSipWhiteListItem($sip_whitelist_id, $sip_whitelist_network)

Edits the SIP white list.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: api_key
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('api_key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api_key', 'Bearer');
// Configure API key authorization: account_name
Voximplant\Configuration::getDefaultConfiguration()->setApiKey('account_name', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Voximplant\Configuration::getDefaultConfiguration()->setApiKeyPrefix('account_name', 'Bearer');

$api_instance = new Voximplant\Api\ManagingSIPWhiteListApi();
$sip_whitelist_id = 3.4; // float | The SIP white list item ID
$sip_whitelist_network = "sip_whitelist_network_example"; // 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)

try {
    $result = $api_instance->setSipWhiteListItem($sip_whitelist_id, $sip_whitelist_network);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ManagingSIPWhiteListApi->setSipWhiteListItem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
sip_whitelist_id float 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)

Return type

\Voximplant\Model\ActivateCallerIDAPIResponse

Authorization

api_key, account_name

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]