deltacore / voip-api
dev-main
2023-01-25 21:07 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~2.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2025-06-26 02:31:27 UTC
README
Client REST API
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 2.20.0
- Build package: io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.5 and later
Installation & Usage
Composer
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "https://github.com/GroupeOndi/deltacore/voip-api.git"
}
],
"require": {
"GroupeOndi/deltacore/voip-api": "*@dev"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: bearer $config = Delta\Voip\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = Delta\Voip\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new Delta\Voip\Api\AuthApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $username = "username_example"; // string | $password = "password_example"; // string | try { $apiInstance->postAdminAuthenticate($username, $password); } catch (Exception $e) { echo 'Exception when calling AuthApi->postAdminAuthenticate: ', $e->getMessage(), PHP_EOL; } ?>
Documentation for API Endpoints
All URIs are relative to https://localhost/api/client/
Class | Method | HTTP request | Description |
---|---|---|---|
AuthApi | postAdminAuthenticate | POST /admin_login | Retrieve JWT token |
AuthApi | postAuthTokenExchangeTokenCollection | POST /token/exchange | Creates a Token resource. |
AuthApi | postTokenRefresh | POST /token/refresh | Retrieve JWT token |
AuthApi | postUserAuthenticate | POST /user_login | Retrieve JWT token |
KamApi | getUsersCdrCollection | GET /users_cdrs | Retrieves the collection of UsersCdr resources. |
KamApi | getUsersCdrItem | GET /users_cdrs/{id} | Retrieves a UsersCdr resource. |
MyApi | getCallStatsItem | GET /my/call_stats | Retrieves a CallStats resource. |
MyApi | getMyActiveCallsActiveCallsItem | GET /my/active_calls | Retrieves a ActiveCalls resource. |
MyApi | getMyCallForwardSettingsCallForwardSettingCollection | GET /my/call_forward_settings | Retrieves the collection of CallForwardSetting resources. |
MyApi | getMyCallHistoryUsersCdrCollection | GET /my/call_history | Retrieves the collection of UsersCdr resources. |
MyApi | getMyCompanyAssistantsUserCollection | GET /my/company_assistants | Retrieves the collection of User resources. |
MyApi | getMyCompanyCountryCountryItem | GET /my/company_country | Retrieves a Country resource. |
MyApi | getMyCompanyExtensionsExtensionCollection | GET /my/company_extensions | Retrieves the collection of Extension resources. |
MyApi | getMyCompanyVoicemailsUserCollection | GET /my/company_voicemails | Retrieves the collection of User resources. |
MyApi | getMyProfileUserItem | GET /my/profile | Retrieves a User resource. |
MyApi | getMyRegistrationSummaryRegistrationSummaryItem | GET /my/registration_summary | Retrieves a RegistrationSummary resource. |
MyApi | getUserStatusItem | GET /my/status | Retrieves a UserStatus resource. |
MyApi | getWebThemeItem | GET /my/web_theme | Retrieves a WebTheme resource. |
MyApi | postMyCallForwardSettingsCallForwardSettingItem | POST /my/call_forward_settings | Creates a CallForwardSetting resource. |
MyApi | putMyProfileUserItem | PUT /my/profile | Replaces the User resource. |
ProviderApi | callcsvreportCsvCallCsvReportItem | GET /call_csv_reports/{id}/csv | Retrieves a CallCsvReport resource. |
ProviderApi | deleteCalendarItem | DELETE /calendars/{id} | Removes the Calendar resource. |
ProviderApi | deleteCalendarPeriodItem | DELETE /calendar_periods/{id} | Removes the CalendarPeriod resource. |
ProviderApi | deleteCalendarPeriodsRelScheduleItem | DELETE /calendar_periods_rel_schedules/{id} | Removes the CalendarPeriodsRelSchedule resource. |
ProviderApi | deleteCallAclItem | DELETE /call_acls/{id} | Removes the CallAcl resource. |
ProviderApi | deleteCallAclRelMatchListItem | DELETE /call_acl_rel_match_lists/{id} | Removes the CallAclRelMatchList resource. |
ProviderApi | deleteCallCsvSchedulerItem | DELETE /call_csv_schedulers/{id} | Removes the CallCsvScheduler resource. |
ProviderApi | deleteCallForwardSettingItem | DELETE /call_forward_settings/{id} | Removes the CallForwardSetting resource. |
ProviderApi | deleteCompanyServiceItem | DELETE /company_services/{id} | Removes the CompanyService resource. |
ProviderApi | deleteConditionalRouteItem | DELETE /conditional_routes/{id} | Removes the ConditionalRoute resource. |
ProviderApi | deleteConditionalRoutesConditionItem | DELETE /conditional_routes_conditions/{id} | Removes the ConditionalRoutesCondition resource. |
ProviderApi | deleteConditionalRoutesConditionsRelCalendarItem | DELETE /conditional_routes_conditions_rel_calendars/{id} | Removes the ConditionalRoutesConditionsRelCalendar resource. |
ProviderApi | deleteConditionalRoutesConditionsRelMatchlistItem | DELETE /conditional_routes_conditions_rel_matchlists/{id} | Removes the ConditionalRoutesConditionsRelMatchlist resource. |
ProviderApi | deleteConditionalRoutesConditionsRelRouteLockItem | DELETE /conditional_routes_conditions_rel_route_locks/{id} | Removes the ConditionalRoutesConditionsRelRouteLock resource. |
ProviderApi | deleteConditionalRoutesConditionsRelScheduleItem | DELETE /conditional_routes_conditions_rel_schedules/{id} | Removes the ConditionalRoutesConditionsRelSchedule resource. |
ProviderApi | deleteConferenceRoomItem | DELETE /conference_rooms/{id} | Removes the ConferenceRoom resource. |
ProviderApi | deleteExtensionItem | DELETE /extensions/{id} | Removes the Extension resource. |
ProviderApi | deleteExternalCallFilterBlackListItem | DELETE /external_call_filter_black_lists/{id} | Removes the ExternalCallFilterBlackList resource. |
ProviderApi | deleteExternalCallFilterItem | DELETE /external_call_filters/{id} | Removes the ExternalCallFilter resource. |
ProviderApi | deleteExternalCallFilterRelCalendarItem | DELETE /external_call_filter_rel_calendars/{id} | Removes the ExternalCallFilterRelCalendar resource. |
ProviderApi | deleteExternalCallFilterRelScheduleItem | DELETE /external_call_filter_rel_schedules/{id} | Removes the ExternalCallFilterRelSchedule resource. |
ProviderApi | deleteExternalCallFilterWhiteListItem | DELETE /external_call_filter_white_lists/{id} | Removes the ExternalCallFilterWhiteList resource. |
ProviderApi | deleteFaxItem | DELETE /faxes/{id} | Removes the Fax resource. |
ProviderApi | deleteFriendItem | DELETE /friends/{id} | Removes the Friend resource. |
ProviderApi | deleteFriendsPatternItem | DELETE /friends_patterns/{id} | Removes the FriendsPattern resource. |
ProviderApi | deleteHolidayDateItem | DELETE /holiday_dates/{id} | Removes the HolidayDate resource. |
ProviderApi | deleteHuntGroupItem | DELETE /hunt_groups/{id} | Removes the HuntGroup resource. |
ProviderApi | deleteHuntGroupsRelUserItem | DELETE /hunt_groups_rel_users/{id} | Removes the HuntGroupsRelUser resource. |
ProviderApi | deleteIvrEntryItem | DELETE /ivr_entries/{id} | Removes the IvrEntry resource. |
ProviderApi | deleteIvrExcludedExtensionItem | DELETE /ivr_excluded_extensions/{id} | Removes the IvrExcludedExtension resource. |
ProviderApi | deleteIvrItem | DELETE /ivrs/{id} | Removes the Ivr resource. |
ProviderApi | deleteLocationItem | DELETE /locations/{id} | Removes the Location resource. |
ProviderApi | deleteLocutionItem | DELETE /locutions/{id} | Removes the Locution resource. |
ProviderApi | deleteMatchListItem | DELETE /match_lists/{id} | Removes the MatchList resource. |
ProviderApi | deleteMatchListPatternItem | DELETE /match_list_patterns/{id} | Removes the MatchListPattern resource. |
ProviderApi | deleteMusicOnHoldItem | DELETE /music_on_holds/{id} | Removes the MusicOnHold resource. |
ProviderApi | deleteOutgoingDdiRuleItem | DELETE /outgoing_ddi_rules/{id} | Removes the OutgoingDdiRule resource. |
ProviderApi | deleteOutgoingDdiRulesPatternItem | DELETE /outgoing_ddi_rules_patterns/{id} | Removes the OutgoingDdiRulesPattern resource. |
ProviderApi | deletePickUpGroupItem | DELETE /pick_up_groups/{id} | Removes the PickUpGroup resource. |
ProviderApi | deletePickUpRelUserItem | DELETE /pick_up_rel_users/{id} | Removes the PickUpRelUser resource. |
ProviderApi | deleteQueueItem | DELETE /queues/{id} | Removes the Queue resource. |
ProviderApi | deleteQueueMemberItem | DELETE /queue_members/{id} | Removes the QueueMember resource. |
ProviderApi | deleteRecordingItem | DELETE /recordings/{id} | Removes the Recording resource. |
ProviderApi | deleteRouteLockItem | DELETE /route_locks/{id} | Removes the RouteLock resource. |
ProviderApi | deleteScheduleItem | DELETE /schedules/{id} | Removes the Schedule resource. |
ProviderApi | deleteTerminalItem | DELETE /terminals/{id} | Removes the Terminal resource. |
ProviderApi | deleteUserItem | DELETE /users/{id} | Removes the User resource. |
ProviderApi | faxesinoutFileFaxesInOutItem | GET /faxes_in_outs/{id}/file | Retrieves a FaxesInOut resource. |
ProviderApi | getBillableCallCollection | GET /billable_calls | Retrieves the collection of BillableCall resources. |
ProviderApi | getBillableCallItem | GET /billable_calls/{id} | Retrieves a BillableCall resource. |
ProviderApi | getCalendarCollection | GET /calendars | Retrieves the collection of Calendar resources. |
ProviderApi | getCalendarItem | GET /calendars/{id} | Retrieves a Calendar resource. |
ProviderApi | getCalendarPeriodCollection | GET /calendar_periods | Retrieves the collection of CalendarPeriod resources. |
ProviderApi | getCalendarPeriodItem | GET /calendar_periods/{id} | Retrieves a CalendarPeriod resource. |
ProviderApi | getCalendarPeriodsRelScheduleCollection | GET /calendar_periods_rel_schedules | Retrieves the collection of CalendarPeriodsRelSchedule resources. |
ProviderApi | getCalendarPeriodsRelScheduleItem | GET /calendar_periods_rel_schedules/{id} | Retrieves a CalendarPeriodsRelSchedule resource. |
ProviderApi | getCallAclCollection | GET /call_acls | Retrieves the collection of CallAcl resources. |
ProviderApi | getCallAclItem | GET /call_acls/{id} | Retrieves a CallAcl resource. |
ProviderApi | getCallAclRelMatchListCollection | GET /call_acl_rel_match_lists | Retrieves the collection of CallAclRelMatchList resources. |
ProviderApi | getCallAclRelMatchListItem | GET /call_acl_rel_match_lists/{id} | Retrieves a CallAclRelMatchList resource. |
ProviderApi | getCallCsvReportCollection | GET /call_csv_reports | Retrieves the collection of CallCsvReport resources. |
ProviderApi | getCallCsvReportItem | GET /call_csv_reports/{id} | Retrieves a CallCsvReport resource. |
ProviderApi | getCallCsvSchedulerCollection | GET /call_csv_schedulers | Retrieves the collection of CallCsvScheduler resources. |
ProviderApi | getCallCsvSchedulerItem | GET /call_csv_schedulers/{id} | Retrieves a CallCsvScheduler resource. |
ProviderApi | getCallForwardSettingCollection | GET /call_forward_settings | Retrieves the collection of CallForwardSetting resources. |
ProviderApi | getCallForwardSettingItem | GET /call_forward_settings/{id} | Retrieves a CallForwardSetting resource. |
ProviderApi | getCompanyCollection | GET /companies | Retrieves the collection of Company resources. |
ProviderApi | getCompanyItem | GET /companies/{id} | Retrieves a Company resource. |
ProviderApi | getCompanyServiceCollection | GET /company_services | Retrieves the collection of CompanyService resources. |
ProviderApi | getCompanyServiceItem | GET /company_services/{id} | Retrieves a CompanyService resource. |
ProviderApi | getConditionalRouteCollection | GET /conditional_routes | Retrieves the collection of ConditionalRoute resources. |
ProviderApi | getConditionalRouteItem | GET /conditional_routes/{id} | Retrieves a ConditionalRoute resource. |
ProviderApi | getConditionalRoutesConditionCollection | GET /conditional_routes_conditions | Retrieves the collection of ConditionalRoutesCondition resources. |
ProviderApi | getConditionalRoutesConditionItem | GET /conditional_routes_conditions/{id} | Retrieves a ConditionalRoutesCondition resource. |
ProviderApi | getConditionalRoutesConditionsRelCalendarCollection | GET /conditional_routes_conditions_rel_calendars | Retrieves the collection of ConditionalRoutesConditionsRelCalendar resources. |
ProviderApi | getConditionalRoutesConditionsRelCalendarItem | GET /conditional_routes_conditions_rel_calendars/{id} | Retrieves a ConditionalRoutesConditionsRelCalendar resource. |
ProviderApi | getConditionalRoutesConditionsRelMatchlistCollection | GET /conditional_routes_conditions_rel_matchlists | Retrieves the collection of ConditionalRoutesConditionsRelMatchlist resources. |
ProviderApi | getConditionalRoutesConditionsRelMatchlistItem | GET /conditional_routes_conditions_rel_matchlists/{id} | Retrieves a ConditionalRoutesConditionsRelMatchlist resource. |
ProviderApi | getConditionalRoutesConditionsRelRouteLockCollection | GET /conditional_routes_conditions_rel_route_locks | Retrieves the collection of ConditionalRoutesConditionsRelRouteLock resources. |
ProviderApi | getConditionalRoutesConditionsRelRouteLockItem | GET /conditional_routes_conditions_rel_route_locks/{id} | Retrieves a ConditionalRoutesConditionsRelRouteLock resource. |
ProviderApi | getConditionalRoutesConditionsRelScheduleCollection | GET /conditional_routes_conditions_rel_schedules | Retrieves the collection of ConditionalRoutesConditionsRelSchedule resources. |
ProviderApi | getConditionalRoutesConditionsRelScheduleItem | GET /conditional_routes_conditions_rel_schedules/{id} | Retrieves a ConditionalRoutesConditionsRelSchedule resource. |
ProviderApi | getConferenceRoomCollection | GET /conference_rooms | Retrieves the collection of ConferenceRoom resources. |
ProviderApi | getConferenceRoomItem | GET /conference_rooms/{id} | Retrieves a ConferenceRoom resource. |
ProviderApi | getCountryCollection | GET /countries | Retrieves the collection of Country resources. |
ProviderApi | getCountryItem | GET /countries/{id} | Retrieves a Country resource. |
ProviderApi | getDdiCollection | GET /ddis | Retrieves the collection of Ddi resources. |
ProviderApi | getDdiItem | GET /ddis/{id} | Retrieves a Ddi resource. |
ProviderApi | getExtensionCollection | GET /extensions | Retrieves the collection of Extension resources. |
ProviderApi | getExtensionItem | GET /extensions/{id} | Retrieves a Extension resource. |
ProviderApi | getExternalCallFilterBlackListCollection | GET /external_call_filter_black_lists | Retrieves the collection of ExternalCallFilterBlackList resources. |
ProviderApi | getExternalCallFilterBlackListItem | GET /external_call_filter_black_lists/{id} | Retrieves a ExternalCallFilterBlackList resource. |
ProviderApi | getExternalCallFilterCollection | GET /external_call_filters | Retrieves the collection of ExternalCallFilter resources. |
ProviderApi | getExternalCallFilterItem | GET /external_call_filters/{id} | Retrieves a ExternalCallFilter resource. |
ProviderApi | getExternalCallFilterRelCalendarCollection | GET /external_call_filter_rel_calendars | Retrieves the collection of ExternalCallFilterRelCalendar resources. |
ProviderApi | getExternalCallFilterRelCalendarItem | GET /external_call_filter_rel_calendars/{id} | Retrieves a ExternalCallFilterRelCalendar resource. |
ProviderApi | getExternalCallFilterRelScheduleCollection | GET /external_call_filter_rel_schedules | Retrieves the collection of ExternalCallFilterRelSchedule resources. |
ProviderApi | getExternalCallFilterRelScheduleItem | GET /external_call_filter_rel_schedules/{id} | Retrieves a ExternalCallFilterRelSchedule resource. |
ProviderApi | getExternalCallFilterWhiteListCollection | GET /external_call_filter_white_lists | Retrieves the collection of ExternalCallFilterWhiteList resources. |
ProviderApi | getExternalCallFilterWhiteListItem | GET /external_call_filter_white_lists/{id} | Retrieves a ExternalCallFilterWhiteList resource. |
ProviderApi | getFaxCollection | GET /faxes | Retrieves the collection of Fax resources. |
ProviderApi | getFaxItem | GET /faxes/{id} | Retrieves a Fax resource. |
ProviderApi | getFaxesInOutCollection | GET /faxes_in_outs | Retrieves the collection of FaxesInOut resources. |
ProviderApi | getFaxesInOutItem | GET /faxes_in_outs/{id} | Retrieves a FaxesInOut resource. |
ProviderApi | getFeaturesRelCompanyCollection | GET /features_rel_companies | Retrieves the collection of FeaturesRelCompany resources. |
ProviderApi | getFeaturesRelCompanyItem | GET /features_rel_companies/{id} | Retrieves a FeaturesRelCompany resource. |
ProviderApi | getFriendCollection | GET /friends | Retrieves the collection of Friend resources. |
ProviderApi | getFriendItem | GET /friends/{id} | Retrieves a Friend resource. |
ProviderApi | getFriendsPatternCollection | GET /friends_patterns | Retrieves the collection of FriendsPattern resources. |
ProviderApi | getFriendsPatternItem | GET /friends_patterns/{id} | Retrieves a FriendsPattern resource. |
ProviderApi | getHolidayDateCollection | GET /holiday_dates | Retrieves the collection of HolidayDate resources. |
ProviderApi | getHolidayDateItem | GET /holiday_dates/{id} | Retrieves a HolidayDate resource. |
ProviderApi | getHuntGroupCollection | GET /hunt_groups | Retrieves the collection of HuntGroup resources. |
ProviderApi | getHuntGroupItem | GET /hunt_groups/{id} | Retrieves a HuntGroup resource. |
ProviderApi | getHuntGroupsRelUserCollection | GET /hunt_groups_rel_users | Retrieves the collection of HuntGroupsRelUser resources. |
ProviderApi | getHuntGroupsRelUserItem | GET /hunt_groups_rel_users/{id} | Retrieves a HuntGroupsRelUser resource. |
ProviderApi | getIvrCollection | GET /ivrs | Retrieves the collection of Ivr resources. |
ProviderApi | getIvrEntryCollection | GET /ivr_entries | Retrieves the collection of IvrEntry resources. |
ProviderApi | getIvrEntryItem | GET /ivr_entries/{id} | Retrieves a IvrEntry resource. |
ProviderApi | getIvrExcludedExtensionCollection | GET /ivr_excluded_extensions | Retrieves the collection of IvrExcludedExtension resources. |
ProviderApi | getIvrExcludedExtensionItem | GET /ivr_excluded_extensions/{id} | Retrieves a IvrExcludedExtension resource. |
ProviderApi | getIvrItem | GET /ivrs/{id} | Retrieves a Ivr resource. |
ProviderApi | getLanguageCollection | GET /languages | Retrieves the collection of Language resources. |
ProviderApi | getLanguageItem | GET /languages/{id} | Retrieves a Language resource. |
ProviderApi | getLocationCollection | GET /locations | Retrieves the collection of Location resources. |
ProviderApi | getLocationItem | GET /locations/{id} | Retrieves a Location resource. |
ProviderApi | getLocutionCollection | GET /locutions | Retrieves the collection of Locution resources. |
ProviderApi | getLocutionItem | GET /locutions/{id} | Retrieves a Locution resource. |
ProviderApi | getMatchListCollection | GET /match_lists | Retrieves the collection of MatchList resources. |
ProviderApi | getMatchListItem | GET /match_lists/{id} | Retrieves a MatchList resource. |
ProviderApi | getMatchListPatternCollection | GET /match_list_patterns | Retrieves the collection of MatchListPattern resources. |
ProviderApi | getMatchListPatternItem | GET /match_list_patterns/{id} | Retrieves a MatchListPattern resource. |
ProviderApi | getMusicOnHoldCollection | GET /music_on_holds | Retrieves the collection of MusicOnHold resources. |
ProviderApi | getMusicOnHoldItem | GET /music_on_holds/{id} | Retrieves a MusicOnHold resource. |
ProviderApi | getMyRatingPlanPricesRatingPlanPricesCollection | GET /rating_plan_groups/{id}/prices | Retrieves the collection of RatingPlanPrices resources. |
ProviderApi | getOutgoingDdiRuleCollection | GET /outgoing_ddi_rules | Retrieves the collection of OutgoingDdiRule resources. |
ProviderApi | getOutgoingDdiRuleItem | GET /outgoing_ddi_rules/{id} | Retrieves a OutgoingDdiRule resource. |
ProviderApi | getOutgoingDdiRulesPatternCollection | GET /outgoing_ddi_rules_patterns | Retrieves the collection of OutgoingDdiRulesPattern resources. |
ProviderApi | getOutgoingDdiRulesPatternItem | GET /outgoing_ddi_rules_patterns/{id} | Retrieves a OutgoingDdiRulesPattern resource. |
ProviderApi | getPickUpGroupCollection | GET /pick_up_groups | Retrieves the collection of PickUpGroup resources. |
ProviderApi | getPickUpGroupItem | GET /pick_up_groups/{id} | Retrieves a PickUpGroup resource. |
ProviderApi | getPickUpRelUserCollection | GET /pick_up_rel_users | Retrieves the collection of PickUpRelUser resources. |
ProviderApi | getPickUpRelUserItem | GET /pick_up_rel_users/{id} | Retrieves a PickUpRelUser resource. |
ProviderApi | getQueueCollection | GET /queues | Retrieves the collection of Queue resources. |
ProviderApi | getQueueItem | GET /queues/{id} | Retrieves a Queue resource. |
ProviderApi | getQueueMemberCollection | GET /queue_members | Retrieves the collection of QueueMember resources. |
ProviderApi | getQueueMemberItem | GET /queue_members/{id} | Retrieves a QueueMember resource. |
ProviderApi | getRatingPlanGroupCollection | GET /rating_plan_groups | Retrieves the collection of RatingPlanGroup resources. |
ProviderApi | getRatingPlanGroupItem | GET /rating_plan_groups/{id} | Retrieves a RatingPlanGroup resource. |
ProviderApi | getRatingProfileCollection | GET /rating_profiles | Retrieves the collection of RatingProfile resources. |
ProviderApi | getRatingProfileItem | GET /rating_profiles/{id} | Retrieves a RatingProfile resource. |
ProviderApi | getRecordingCollection | GET /recordings | Retrieves the collection of Recording resources. |
ProviderApi | getRecordingItem | GET /recordings/{id} | Retrieves a Recording resource. |
ProviderApi | getResidentialDeviceCollection | GET /residential_devices | Retrieves the collection of ResidentialDevice resources. |
ProviderApi | getResidentialDeviceItem | GET /residential_devices/{id} | Retrieves a ResidentialDevice resource. |
ProviderApi | getRetailAccountCollection | GET /retail_accounts | Retrieves the collection of RetailAccount resources. |
ProviderApi | getRetailAccountItem | GET /retail_accounts/{id} | Retrieves a RetailAccount resource. |
ProviderApi | getRouteLockCollection | GET /route_locks | Retrieves the collection of RouteLock resources. |
ProviderApi | getRouteLockItem | GET /route_locks/{id} | Retrieves a RouteLock resource. |
ProviderApi | getRoutingTagCollection | GET /routing_tags | Retrieves the collection of RoutingTag resources. |
ProviderApi | getRoutingTagItem | GET /routing_tags/{id} | Retrieves a RoutingTag resource. |
ProviderApi | getScheduleCollection | GET /schedules | Retrieves the collection of Schedule resources. |
ProviderApi | getScheduleItem | GET /schedules/{id} | Retrieves a Schedule resource. |
ProviderApi | getServiceCollection | GET /services | Retrieves the collection of Service resources. |
ProviderApi | getServiceItem | GET /services/{id} | Retrieves a Service resource. |
ProviderApi | getServicesUnassignedServiceCollection | GET /services/unassigned | Retrieves the collection of Service resources. |
ProviderApi | getStatusCollectionFriendCollection | GET /friends/status | Retrieves the collection of Friend resources. |
ProviderApi | getStatusCollectionResidentialDeviceCollection | GET /residential_devices/status | Retrieves the collection of ResidentialDevice resources. |
ProviderApi | getStatusCollectionRetailAccountCollection | GET /retail_accounts/status | Retrieves the collection of RetailAccount resources. |
ProviderApi | getStatusCollectionTerminalCollection | GET /terminals/status | Retrieves the collection of Terminal resources. |
ProviderApi | getStatusItemFriendItem | GET /friends/{id}/status | Retrieves a Friend resource. |
ProviderApi | getStatusItemResidentialDeviceItem | GET /residential_devices/{id}/status | Retrieves a ResidentialDevice resource. |
ProviderApi | getStatusItemRetailAccountItem | GET /retail_accounts/{id}/status | Retrieves a RetailAccount resource. |
ProviderApi | getStatusItemTerminalItem | GET /terminals/{id}/status | Retrieves a Terminal resource. |
ProviderApi | getTerminalCollection | GET /terminals | Retrieves the collection of Terminal resources. |
ProviderApi | getTerminalItem | GET /terminals/{id} | Retrieves a Terminal resource. |
ProviderApi | getTerminalModelCollection | GET /terminal_models | Retrieves the collection of TerminalModel resources. |
ProviderApi | getTerminalModelItem | GET /terminal_models/{id} | Retrieves a TerminalModel resource. |
ProviderApi | getTimezoneCollection | GET /timezones | Retrieves the collection of Timezone resources. |
ProviderApi | getTimezoneItem | GET /timezones/{id} | Retrieves a Timezone resource. |
ProviderApi | getTransformationRuleSetCollection | GET /transformation_rule_sets | Retrieves the collection of TransformationRuleSet resources. |
ProviderApi | getTransformationRuleSetItem | GET /transformation_rule_sets/{id} | Retrieves a TransformationRuleSet resource. |
ProviderApi | getUserCollection | GET /users | Retrieves the collection of User resources. |
ProviderApi | getUserItem | GET /users/{id} | Retrieves a User resource. |
ProviderApi | locutionEncodedfileLocutionItem | GET /locutions/{id}/encodedfile | Retrieves a Locution resource. |
ProviderApi | locutionOriginalfileLocutionItem | GET /locutions/{id}/originalfile | Retrieves a Locution resource. |
ProviderApi | musiconholdEncodedfileMusicOnHoldItem | GET /music_on_holds/{id}/encodedfile | Retrieves a MusicOnHold resource. |
ProviderApi | musiconholdOriginalfileMusicOnHoldItem | GET /music_on_holds/{id}/originalfile | Retrieves a MusicOnHold resource. |
ProviderApi | postCalendarCollection | POST /calendars | Creates a Calendar resource. |
ProviderApi | postCalendarPeriodCollection | POST /calendar_periods | Creates a CalendarPeriod resource. |
ProviderApi | postCalendarPeriodsRelScheduleCollection | POST /calendar_periods_rel_schedules | Creates a CalendarPeriodsRelSchedule resource. |
ProviderApi | postCallAclCollection | POST /call_acls | Creates a CallAcl resource. |
ProviderApi | postCallAclRelMatchListCollection | POST /call_acl_rel_match_lists | Creates a CallAclRelMatchList resource. |
ProviderApi | postCallCsvSchedulerCollection | POST /call_csv_schedulers | Creates a CallCsvScheduler resource. |
ProviderApi | postCallForwardSettingCollection | POST /call_forward_settings | Creates a CallForwardSetting resource. |
ProviderApi | postCompanyServiceCollection | POST /company_services | Creates a CompanyService resource. |
ProviderApi | postConditionalRouteCollection | POST /conditional_routes | Creates a ConditionalRoute resource. |
ProviderApi | postConditionalRoutesConditionCollection | POST /conditional_routes_conditions | Creates a ConditionalRoutesCondition resource. |
ProviderApi | postConditionalRoutesConditionsRelCalendarCollection | POST /conditional_routes_conditions_rel_calendars | Creates a ConditionalRoutesConditionsRelCalendar resource. |
ProviderApi | postConditionalRoutesConditionsRelMatchlistCollection | POST /conditional_routes_conditions_rel_matchlists | Creates a ConditionalRoutesConditionsRelMatchlist resource. |
ProviderApi | postConditionalRoutesConditionsRelRouteLockCollection | POST /conditional_routes_conditions_rel_route_locks | Creates a ConditionalRoutesConditionsRelRouteLock resource. |
ProviderApi | postConditionalRoutesConditionsRelScheduleCollection | POST /conditional_routes_conditions_rel_schedules | Creates a ConditionalRoutesConditionsRelSchedule resource. |
ProviderApi | postConferenceRoomCollection | POST /conference_rooms | Creates a ConferenceRoom resource. |
ProviderApi | postExtensionCollection | POST /extensions | Creates a Extension resource. |
ProviderApi | postExternalCallFilterBlackListCollection | POST /external_call_filter_black_lists | Creates a ExternalCallFilterBlackList resource. |
ProviderApi | postExternalCallFilterCollection | POST /external_call_filters | Creates a ExternalCallFilter resource. |
ProviderApi | postExternalCallFilterRelCalendarCollection | POST /external_call_filter_rel_calendars | Creates a ExternalCallFilterRelCalendar resource. |
ProviderApi | postExternalCallFilterRelScheduleCollection | POST /external_call_filter_rel_schedules | Creates a ExternalCallFilterRelSchedule resource. |
ProviderApi | postExternalCallFilterWhiteListCollection | POST /external_call_filter_white_lists | Creates a ExternalCallFilterWhiteList resource. |
ProviderApi | postFaxCollection | POST /faxes | Creates a Fax resource. |
ProviderApi | postFriendCollection | POST /friends | Creates a Friend resource. |
ProviderApi | postFriendsPatternCollection | POST /friends_patterns | Creates a FriendsPattern resource. |
ProviderApi | postHolidayDateCollection | POST /holiday_dates | Creates a HolidayDate resource. |
ProviderApi | postHuntGroupCollection | POST /hunt_groups | Creates a HuntGroup resource. |
ProviderApi | postHuntGroupsRelUserCollection | POST /hunt_groups_rel_users | Creates a HuntGroupsRelUser resource. |
ProviderApi | postIvrCollection | POST /ivrs | Creates a Ivr resource. |
ProviderApi | postIvrEntryCollection | POST /ivr_entries | Creates a IvrEntry resource. |
ProviderApi | postIvrExcludedExtensionCollection | POST /ivr_excluded_extensions | Creates a IvrExcludedExtension resource. |
ProviderApi | postLocationCollection | POST /locations | Creates a Location resource. |
ProviderApi | postLocutionCollection | POST /locutions | Creates a Locution resource. |
ProviderApi | postMatchListCollection | POST /match_lists | Creates a MatchList resource. |
ProviderApi | postMatchListPatternCollection | POST /match_list_patterns | Creates a MatchListPattern resource. |
ProviderApi | postMusicOnHoldCollection | POST /music_on_holds | Creates a MusicOnHold resource. |
ProviderApi | postOutgoingDdiRuleCollection | POST /outgoing_ddi_rules | Creates a OutgoingDdiRule resource. |
ProviderApi | postOutgoingDdiRulesPatternCollection | POST /outgoing_ddi_rules_patterns | Creates a OutgoingDdiRulesPattern resource. |
ProviderApi | postPickUpGroupCollection | POST /pick_up_groups | Creates a PickUpGroup resource. |
ProviderApi | postPickUpRelUserCollection | POST /pick_up_rel_users | Creates a PickUpRelUser resource. |
ProviderApi | postQueueCollection | POST /queues | Creates a Queue resource. |
ProviderApi | postQueueMemberCollection | POST /queue_members | Creates a QueueMember resource. |
ProviderApi | postRouteLockCollection | POST /route_locks | Creates a RouteLock resource. |
ProviderApi | postScheduleCollection | POST /schedules | Creates a Schedule resource. |
ProviderApi | postTerminalCollection | POST /terminals | Creates a Terminal resource. |
ProviderApi | postUserCollection | POST /users | Creates a User resource. |
ProviderApi | putCalendarItem | PUT /calendars/{id} | Replaces the Calendar resource. |
ProviderApi | putCalendarPeriodItem | PUT /calendar_periods/{id} | Replaces the CalendarPeriod resource. |
ProviderApi | putCalendarPeriodsRelScheduleItem | PUT /calendar_periods_rel_schedules/{id} | Replaces the CalendarPeriodsRelSchedule resource. |
ProviderApi | putCallAclItem | PUT /call_acls/{id} | Replaces the CallAcl resource. |
ProviderApi | putCallAclRelMatchListItem | PUT /call_acl_rel_match_lists/{id} | Replaces the CallAclRelMatchList resource. |
ProviderApi | putCallCsvSchedulerItem | PUT /call_csv_schedulers/{id} | Replaces the CallCsvScheduler resource. |
ProviderApi | putCallForwardSettingItem | PUT /call_forward_settings/{id} | Replaces the CallForwardSetting resource. |
ProviderApi | putCompanyServiceItem | PUT /company_services/{id} | Replaces the CompanyService resource. |
ProviderApi | putConditionalRouteItem | PUT /conditional_routes/{id} | Replaces the ConditionalRoute resource. |
ProviderApi | putConditionalRoutesConditionItem | PUT /conditional_routes_conditions/{id} | Replaces the ConditionalRoutesCondition resource. |
ProviderApi | putConferenceRoomItem | PUT /conference_rooms/{id} | Replaces the ConferenceRoom resource. |
ProviderApi | putDdiItem | PUT /ddis/{id} | Replaces the Ddi resource. |
ProviderApi | putExtensionItem | PUT /extensions/{id} | Replaces the Extension resource. |
ProviderApi | putExternalCallFilterBlackListItem | PUT /external_call_filter_black_lists/{id} | Replaces the ExternalCallFilterBlackList resource. |
ProviderApi | putExternalCallFilterItem | PUT /external_call_filters/{id} | Replaces the ExternalCallFilter resource. |
ProviderApi | putExternalCallFilterRelCalendarItem | PUT /external_call_filter_rel_calendars/{id} | Replaces the ExternalCallFilterRelCalendar resource. |
ProviderApi | putExternalCallFilterRelScheduleItem | PUT /external_call_filter_rel_schedules/{id} | Replaces the ExternalCallFilterRelSchedule resource. |
ProviderApi | putExternalCallFilterWhiteListItem | PUT /external_call_filter_white_lists/{id} | Replaces the ExternalCallFilterWhiteList resource. |
ProviderApi | putFaxItem | PUT /faxes/{id} | Replaces the Fax resource. |
ProviderApi | putFriendItem | PUT /friends/{id} | Replaces the Friend resource. |
ProviderApi | putFriendsPatternItem | PUT /friends_patterns/{id} | Replaces the FriendsPattern resource. |
ProviderApi | putHolidayDateItem | PUT /holiday_dates/{id} | Replaces the HolidayDate resource. |
ProviderApi | putHuntGroupItem | PUT /hunt_groups/{id} | Replaces the HuntGroup resource. |
ProviderApi | putHuntGroupsRelUserItem | PUT /hunt_groups_rel_users/{id} | Replaces the HuntGroupsRelUser resource. |
ProviderApi | putIvrEntryItem | PUT /ivr_entries/{id} | Replaces the IvrEntry resource. |
ProviderApi | putIvrExcludedExtensionItem | PUT /ivr_excluded_extensions/{id} | Replaces the IvrExcludedExtension resource. |
ProviderApi | putIvrItem | PUT /ivrs/{id} | Replaces the Ivr resource. |
ProviderApi | putLocationItem | PUT /locations/{id} | Replaces the Location resource. |
ProviderApi | putLocutionItem | PUT /locutions/{id} | Replaces the Locution resource. |
ProviderApi | putMatchListItem | PUT /match_lists/{id} | Replaces the MatchList resource. |
ProviderApi | putMatchListPatternItem | PUT /match_list_patterns/{id} | Replaces the MatchListPattern resource. |
ProviderApi | putMusicOnHoldItem | PUT /music_on_holds/{id} | Replaces the MusicOnHold resource. |
ProviderApi | putOutgoingDdiRuleItem | PUT /outgoing_ddi_rules/{id} | Replaces the OutgoingDdiRule resource. |
ProviderApi | putOutgoingDdiRulesPatternItem | PUT /outgoing_ddi_rules_patterns/{id} | Replaces the OutgoingDdiRulesPattern resource. |
ProviderApi | putPickUpGroupItem | PUT /pick_up_groups/{id} | Replaces the PickUpGroup resource. |
ProviderApi | putPickUpRelUserItem | PUT /pick_up_rel_users/{id} | Replaces the PickUpRelUser resource. |
ProviderApi | putQueueItem | PUT /queues/{id} | Replaces the Queue resource. |
ProviderApi | putQueueMemberItem | PUT /queue_members/{id} | Replaces the QueueMember resource. |
ProviderApi | putResidentialDeviceItem | PUT /residential_devices/{id} | Replaces the ResidentialDevice resource. |
ProviderApi | putRetailAccountItem | PUT /retail_accounts/{id} | Replaces the RetailAccount resource. |
ProviderApi | putRouteLockItem | PUT /route_locks/{id} | Replaces the RouteLock resource. |
ProviderApi | putScheduleItem | PUT /schedules/{id} | Replaces the Schedule resource. |
ProviderApi | putTerminalItem | PUT /terminals/{id} | Replaces the Terminal resource. |
ProviderApi | putUserItem | PUT /users/{id} | Replaces the User resource. |
ProviderApi | recordingRecordedfileRecordingItem | GET /recordings/{id}/recordedfile | Retrieves a Recording resource. |
Documentation For Models
- ActiveCalls
- BillableCallCollection
- BillableCallDetailed
- Calendar
- CalendarCollection
- CalendarDetailed
- CalendarPeriod
- CalendarPeriodCollection
- CalendarPeriodDetailed
- CalendarPeriodsRelSchedule
- CalendarPeriodsRelScheduleDetailed
- CalendarPeriodsRelScheduleDetailedCollection
- CallAcl
- CallAclCollection
- CallAclDetailed
- CallAclRelMatchList
- CallAclRelMatchListDetailed
- CallAclRelMatchListDetailedCollection
- CallCsvReportCollection
- CallCsvReportDetailed
- CallCsvScheduler
- CallCsvSchedulerCollection
- CallCsvSchedulerDetailed
- CallForwardSetting
- CallForwardSettingCollection
- CallForwardSettingDetailed
- CallForwardSettingDetailedCollection
- CallStats
- CompanyCollection
- CompanyDetailed
- CompanyService
- CompanyServiceCollection
- CompanyServiceDetailed
- ConditionalRoute
- ConditionalRouteCollection
- ConditionalRouteDetailed
- ConditionalRoutesCondition
- ConditionalRoutesConditionCollection
- ConditionalRoutesConditionDetailed
- ConditionalRoutesConditionWithInverseRelationships
- ConditionalRoutesConditionsRelCalendar
- ConditionalRoutesConditionsRelCalendarDetailed
- ConditionalRoutesConditionsRelCalendarDetailedCollection
- ConditionalRoutesConditionsRelMatchlist
- ConditionalRoutesConditionsRelMatchlistDetailed
- ConditionalRoutesConditionsRelMatchlistDetailedCollection
- ConditionalRoutesConditionsRelRouteLock
- ConditionalRoutesConditionsRelRouteLockDetailed
- ConditionalRoutesConditionsRelRouteLockDetailedCollection
- ConditionalRoutesConditionsRelSchedule
- ConditionalRoutesConditionsRelScheduleDetailed
- ConditionalRoutesConditionsRelScheduleDetailedCollection
- ConferenceRoom
- ConferenceRoomCollection
- ConferenceRoomDetailed
- Country
- CountryCollection
- CountryDetailed
- CountryName
- CountryZone
- Ddi
- DdiCollection
- DdiDetailed
- Extension
- ExtensionCollection
- ExtensionDetailed
- ExternalCallFilter
- ExternalCallFilterBlackList
- ExternalCallFilterBlackListDetailed
- ExternalCallFilterBlackListDetailedCollection
- ExternalCallFilterCollection
- ExternalCallFilterDetailed
- ExternalCallFilterRelCalendar
- ExternalCallFilterRelCalendarDetailed
- ExternalCallFilterRelCalendarDetailedCollection
- ExternalCallFilterRelSchedule
- ExternalCallFilterRelScheduleDetailed
- ExternalCallFilterRelScheduleDetailedCollection
- ExternalCallFilterWhiteList
- ExternalCallFilterWhiteListDetailed
- ExternalCallFilterWhiteListDetailedCollection
- ExternalCallFilterWithInverseRelationships
- Fax
- FaxCollection
- FaxDetailed
- FaxesInOutCollection
- FaxesInOutDetailed
- Feature
- FeaturesRelCompanyCollection
- FeaturesRelCompanyDetailed
- Friend
- FriendCollection
- FriendDetailed
- FriendStatus
- FriendsPattern
- FriendsPatternCollection
- FriendsPatternDetailed
- HolidayDate
- HolidayDateCollection
- HolidayDateDetailed
- HuntGroup
- HuntGroupCollection
- HuntGroupDetailed
- HuntGroupsRelUser
- HuntGroupsRelUserDetailed
- HuntGroupsRelUserDetailedCollection
- Ivr
- IvrCollection
- IvrDetailed
- IvrEntry
- IvrEntryCollection
- IvrEntryDetailed
- IvrExcludedExtension
- IvrExcludedExtensionDetailed
- IvrExcludedExtensionDetailedCollection
- IvrWithExcludedExtensions
- Language
- LanguageCollection
- LanguageDetailed
- LanguageName
- Location
- LocationCollection
- LocationDetailed
- Locution
- LocutionCollection
- LocutionDetailed
- MatchList
- MatchListCollection
- MatchListDetailed
- MatchListPattern
- MatchListPatternCollection
- MatchListPatternDetailed
- MusicOnHold
- MusicOnHoldCollection
- MusicOnHoldDetailed
- MusicOnHoldEncodedFile
- MusicOnHoldOriginalFile
- NotificationTemplate
- OutgoingDdiRule
- OutgoingDdiRuleCollection
- OutgoingDdiRuleDetailed
- OutgoingDdiRulesPattern
- OutgoingDdiRulesPatternDetailed
- OutgoingDdiRulesPatternDetailedCollection
- PickUpGroup
- PickUpGroupCollection
- PickUpGroupDetailed
- PickUpGroupWithUsers
- PickUpRelUser
- PickUpRelUserDetailed
- PickUpRelUserDetailedCollection
- Queue
- QueueCollection
- QueueDetailed
- QueueMember
- QueueMemberDetailed
- QueueMemberDetailedCollection
- RatingPlanGroup
- RatingPlanGroupCollection
- RatingPlanGroupDetailed
- RatingPlanPrices
- RatingProfileCollection
- RatingProfileDetailed
- RecordingCollection
- RecordingDetailed
- RegistrationStatus
- RegistrationSummary
- ResidentialDevice
- ResidentialDeviceCollection
- ResidentialDeviceDetailed
- ResidentialDeviceStatus
- RetailAccount
- RetailAccountCollection
- RetailAccountDetailed
- RetailAccountStatus
- RouteLock
- RouteLockCollection
- RouteLockDetailed
- RoutingTag
- RoutingTagCollection
- RoutingTagDetailed
- Schedule
- ScheduleCollection
- ScheduleDetailed
- Service
- ServiceCollection
- ServiceDetailed
- Terminal
- TerminalCollection
- TerminalDetailed
- TerminalModel
- TerminalModelCollection
- TerminalModelDetailed
- TerminalStatus
- Timezone
- TimezoneCollection
- TimezoneDetailed
- Token
- TransformationRuleSet
- TransformationRuleSetCollection
- TransformationRuleSetDetailed
- User
- UserCollection
- UserDetailed
- UserMyProfile
- UserStatus
- UserUpdateMyProfile
- UsersCdr
- UsersCdrCollection
- UsersCdrDetailed
- WebTheme
Documentation For Authorization
bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header