Skip to content

VanityNumbers.md

Latest commit

 

History

History
218 lines (150 loc) · 8.05 KB

VanityNumbers.md

File metadata and controls

218 lines (150 loc) · 8.05 KB

DialMyCalls\VanityNumbers

All URIs are relative to https://api.dialmycalls.com/2.0

Method HTTP request Description
deleteVanityNumberById DELETE /vanitynumber/{VanityNumberId} Delete Vanity Number
getVanityNumberById GET /vanitynumber/{VanityNumberId} Get Vanity Number
getVanityNumbers GET /vanitynumbers List Vanity Numbers
updateVanityNumberById PUT /vanitynumber/{VanityNumberId} Update Vanity Number

deleteVanityNumberById

object deleteVanityNumberById($vanityNumberId)

Delete Vanity Number

Delete a vanity number.

Returns the following if a valid identifier was provided, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X DELETE https://$API_KEY@api.dialmycalls.com/2.0/keyword/$VANITYNUMBER_ID

Example

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

// Configure API key authorization: api_key
DialMyCalls\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-ApiKey', 'YOUR_API_KEY');
// Configure HTTP basic authorization: basicAuth
DialMyCalls\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
DialMyCalls\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new \DialMyCalls\Api\VanityNumbers();
$vanityNumberId = "vanityNumberId_example"; // string | VanityNumberId

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

Parameters

Name Type Description Notes
VanityNumberId string VanityNumberId

Return type

object

Authorization

api_key, basicAuth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

getVanityNumberById

object getVanityNumberById($vanityNumberId)

Get Vanity Number

Retrieve a vanity number.

Returns a vanitynumber object if a valid identifier was provided, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X GET https://$API_KEY@api.dialmycalls.com/2.0/vanitynumber/$VANITYNUMBER_ID

Example

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

// Configure API key authorization: api_key
DialMyCalls\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-ApiKey', 'YOUR_API_KEY');
// Configure HTTP basic authorization: basicAuth
DialMyCalls\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
DialMyCalls\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new \DialMyCalls\Api\VanityNumbers();
$vanityNumberId = "vanityNumberId_example"; // string | VanityNumberId

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

Parameters

Name Type Description Notes
VanityNumberId string VanityNumberId

Return type

object

Authorization

api_key, basicAuth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

getVanityNumbers

object getVanityNumbers($range)

List Vanity Numbers

Retrieve a list of vanity numbers.

Returns a list of vanitynumber objects.

curl -i -H "Content-Type: application/json" -X GET https://$API_KEY@api.dialmycalls.com/2.0/vanitynumbers

Example

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

// Configure API key authorization: api_key
DialMyCalls\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-ApiKey', 'YOUR_API_KEY');
// Configure HTTP basic authorization: basicAuth
DialMyCalls\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
DialMyCalls\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new \DialMyCalls\Api\VanityNumbers();
$range = "range_example"; // string | Range (ie \"records=201-300\") of vanitynumbers requested

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

Parameters

Name Type Description Notes
Range string Range (ie &quot;records=201-300&quot;) of vanitynumbers requested [optional]

Return type

object

Authorization

api_key, basicAuth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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

updateVanityNumberById

object updateVanityNumberById($updateVanityNumberByIdParameters, $vanityNumberId)

Update Vanity Number

Update a vanity number.

Returns a vanitynumber object if a valid identifier was provided, and returns an error otherwise.

curl -i -H "Content-Type: application/json" -X PUT -d "{\"ptt_number_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeee\",\"call_options\":{\"voicemail\":true}}" https://$API_KEY@api.dialmycalls.com/2.0/vanitynumber/$VANITYNUMBER_ID

Example

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

// Configure API key authorization: api_key
DialMyCalls\Configuration::getDefaultConfiguration()->setApiKey('X-Auth-ApiKey', 'YOUR_API_KEY');
// Configure HTTP basic authorization: basicAuth
DialMyCalls\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
DialMyCalls\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new \DialMyCalls\Api\VanityNumbers();
$updateVanityNumberByIdParameters = new \DialMyCalls\Models\UpdateVanityNumberByIdParameters(); // \DialMyCalls\Models\UpdateVanityNumberByIdParameters | Request body
$vanityNumberId = "vanityNumberId_example"; // string | VanityNumberId

try {
    $result = $api_instance->updateVanityNumberById($updateVanityNumberByIdParameters, $vanityNumberId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling VanityNumbers->updateVanityNumberById: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
UpdateVanityNumberByIdParameters \DialMyCalls\Models\UpdateVanityNumberByIdParameters Request body
VanityNumberId string VanityNumberId

Return type

object

Authorization

api_key, basicAuth

HTTP request headers

  • Content-Type: application/json, application/xml
  • Accept: application/json, application/xml

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