API Endpoints v.1.20.3.0
General collection URL parameters (can occur only once)
| _offset=4 | offset into the selection result |
| _pagesize=50 | number of items that will be returned in one page |
| _q=abcd | query parameter for full text of all attributes (usually) returned by the collection endpoint. Collection endpoint specific |
The following list enumerates available endpoints with its current status. Available statuses are:
Success successfully implemented, fully operational endpoint
Pendingnot yet implemented endpoint, this is a proposal for further discussion.
Failureendpoint with errors, this might mean that endpoint is under development or regression errors appeared
Example JSON serializations/deserialization details GET /api/version (API Version information) Available Language Codes Available CLIRs Available Ring TypesAdditional collection URL parameters marked with *)
can occur multiple times
attribute : can be any attribute name from the specific collection
direction : one of (ASC,DESC)
| _orderBy=attribute | order result by the given attribute name |
| _order=direction | order using the given direction. |
! just after "=" means negation of the expression
~ just after "=" is transformed to (database) LIKE
: is the esacape character for !,*,~,:
:NULL:is transformed to IS NULL
!:NULL:is transformed to IS NOT NULL
:gt:is transformed to >
:ge:is transformed to >=
:lt:is transformed to <
:le:is transformed to <=
displayName is used as an example attribute name.
| displayName=abcd | select result where the attribute EQUALS "abcd" |
| displayName=~abcd | select result where the attribute CONTAINS "abcd" |
| displayName=!~abcd | select result where the attribute DOES NOT CONTAIN "abcd" |
| displayName=~ab*cd* | wildcard select result where the attribute does contain somthing like "ab..df..cd..lll" |
| displayName=:NULL: | attribute is (database) IS NULL |
| displayName=!:NULL: | attribute is (database) IS NOT NULL |
| displayName=:gt:abcd | attribute is lexically greater than "abcd" |
| contractTypeId=:gt:5 | attribute is numerically greater than "5" for numeric values (database) |
| displayName=:ge:ddd | attribute is lexically greater-equal than "ddd" |
| displayName=:lt:ddd | attribute is lexically lower than "ddd" |
| displayName=:le:ddd | attribute is lexically lower-equal than "ddd" |
Customer |
|||||
| /api/customers *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| SECURITY | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Basic Data |
|||||
| /api/customers/{customerId}/basic-data | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Customer > Contract Information |
|||||
| /api/customers/{customerId}/contract-information | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Subscriptions |
|||||
| /api/customers/{customerId}/subscriptions | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Feature Status |
|||||
| /api/customers/{customerId}/feature-status | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Options |
|||||
| /api/customers/{customerId}/options | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Customer > Options > Enable/Disable External Numbers |
|||||
| /api/customers/{customerId}/options/external-numbers | PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Default System Integrator |
|||||
| /api/customers/{customerId}/default-system-integrator | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Customer > Category |
|||||
| /api/customers/{customer_id}/category | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Snom Transfer |
|||||
| /api/customers/{customer_id}/snom-transfer | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Available Pbx Groups |
|||||
| /api/customers/{customerId}/available-pbx-groups *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Operator Details |
|||||
| /api/customers/{customerId}/operator-details | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Customer > Call Recording |
|||||
| /api/customers/{customerId}/call-recording | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Customer > Port Speeds |
|||||
| /api/customers/{customerId}/port-speeds | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > UaCSTA Protocols |
|||||
| /api/customers/{customerId}/uacsta-protocols | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Monitoring Levels |
|||||
| /api/customers/{customerId}/monitoring-levels | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Codec Profiles |
|||||
| /api/customers/{customerId}/codec-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Count Of Trunks |
|||||
| /api/customers/{customerId}/count-of-trunks | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > EVN Modes |
|||||
| /api/customers/{customerId}/evn-modes | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Cti Billing Modes |
|||||
| /api/customers/{customerId}/cti-billing-modes | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Click To Dial States |
|||||
| /api/customers/{customerId}/click-to-dial-states | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Nmeeting Options |
|||||
| /api/customers/{customerId}/nmeeting-options | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Recording Audio Types |
|||||
| /api/customers/{customerId}/available-recording-audio-types | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Customer > Record Start Message Recipients |
|||||
| /api/customers/{customerId}/available-record-start-message-recipients | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
System Integrator |
|||||
| /api/system-integrators/{systemIntegratorId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
System Integrator > Customers |
|||||
| /api/system-integrators/{systemIntegratorId}/customers *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator |
|||||
| /api/operators | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/operators/{operatorId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Operator > Customers |
|||||
| /api/operators/{operatorId}/customers *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator > Rating Profiles |
|||||
| /api/operators/{operatorId}/rating-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/operators/{operatorId}/rating-profiles/{rating-profile-name} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Operator > Rating Profiles > Available |
|||||
| /api/operators/{operatorId}/rating-profiles/available | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator > System Integrators |
|||||
| /api/operators/{operatorId}/system-integrators | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator > Blacklist Profiles |
|||||
| /api/operators/{operatorId}/blacklist-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/operators/{operatorId}/blacklist-profiles/{blacklistProfileId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator > Pbx Groups |
|||||
| /api/operators/{operatorId}/pbx-groups *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/operators/{operatorId}/pbx-groups/{pbxGroupName} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Operator > Softswitches |
|||||
| /api/operators/{operatorId}/softswitches | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/operators/{operatorId}/softswitches/{softswitchId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Device TypesSpecial device type LYNC is used for skype-or-business |
|||||
| /api/customers/{identifier}/device-types *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/device-types/{deviceTypeName} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Device Types > Firmwares |
|||||
| /api/customers/{identifier}/device-types/{deviceTypeName}/firmwares | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/device-types/{deviceTypeName}/firmwares/{releaseVersion} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
DevicesDevices of the device-type LYNC are used for skype-or-business |
|||||
| /api/customers/{identifier}/devices | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Activation |
|||||
| /api/customers/{identifier}/devices/{deviceCategory}/{deviceId}/activate | PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Bypass Authentication |
|||||
| /api/customers/{identifier}/devices/{deviceId}/bypass-authentication | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Reset Authentication |
|||||
| /api/customers/{identifier}/devices/{deviceId}/reset-authentication | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Sip Credential Renewal |
|||||
| /api/customers/{identifier}/devices/{deviceCategory}/{deviceId}/activation-credentials-renewal | PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Site Options |
|||||
| /api/customers/{identifier}/devices/{deviceCategory}/{deviceId}/site-options | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Unprovisioned Sip Devices |
|||||
| /api/customers/{identifier}/devices/unprovisioned-sip | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/unprovisioned-sip/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > XCAPI Devices |
|||||
| /api/customers/{identifier}/devices/xcapi | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/xcapi/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > ExternalLine Devices | |||||
| /api/customers/{identifier}/devices/external-line | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/external-line/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Standard Devices |
|||||
| /api/customers/{identifier}/devices/standard | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/standard/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Base Devices |
|||||
| /api/customers/{identifier}/devices/base | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/base/{baseId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Base Devices > Free Ports |
|||||
| /api/customers/{identifier}/devices/base/{baseId}/free-ports | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Base Devices > Base Licenses |
|||||
| /api/customers/{identifier}/devices/base/{baseId}/licenses | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/devices/base/{baseId}/licenses/{licenseId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Handset Devices |
|||||
| /api/customers/{identifier}/devices/base/{baseDeviceId}/handsets | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/devices/base/{baseDeviceId}/handsets/{handsetId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Handset Devices > Activation |
|||||
| /api/customers/{identifier}/devices/base/{baseDeviceId}/handsets/{handsetId}/activate | PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Operator Panel |
|||||
| /api/customers/{identifier}/devices/operator-panel | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/operator-panel/{operatorPanelId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Devices > Operator Panel > Available Phones |
|||||
| /api/customers/{identifier}/devices/operator-panel/{operatorPanelId}/available-phones | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices > Softphone DevicesCloudya webapp- and Cloudya mobile devices can be accessed. The devicetype name is Zebra,Zebramobile respectively |
|||||
| /api/customers/{identifier}/devices/softphone | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/devices/softphone/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Trunks |
|||||
| /api/customers/{identifier}/trunks | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/trunks/{trunkNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Trunks > Available Drop Extensions |
|||||
| /api/customers/{identifier}/trunks/{trunkNumber}/available-drop-extensions *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Trunks > Available Extensions |
|||||
| /api/customers/{identifier}/trunks/{trunkNumber}/available-extensions | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
DIDs |
|||||
| /api/customers/{identifier}/dids *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/dids/{didNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
DIDs > Destination |
|||||
| /api/customers/{identifier}/dids/{didNumber}/destination | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
DIDs > Available Destinations |
|||||
| /api/customers/{identifier}/dids/available-destinations *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Site |
|||||
| /api/customers/{identifier}/sites | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{customer_id}/sites/{salesforceId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Site |
|||||
| /api/customers/{identifier}/emergency-sites | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Site > Options |
|||||
| /api/customers/{identifier}/sites/{id}/site-options | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Contracts |
|||||
| /api/customers/{identifier}/contracts/{salesForceId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/devices/{uniqueIdentifier} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Router |
|||||
| /api/customers/{identifier}/routers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/routers/{routerId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Blacklist Profiles |
|||||
| /api/customers/{identifier}/blacklist-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/blacklist-profiles/{blacklistProfileId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Voice Recording Profiles |
|||||
| /api/customers/{identifier}/voice-recording-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/voice-recording-profiles/{voiceRecordingProfileId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Blacklist Global Profiles |
|||||
| /api/customers/{identifier}/blacklist-global-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets |
|||||
| /api/customers/{customer-id}/targets *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > License Subscriptions |
|||||
| /api/customers/{identifier}/targets/license-subscriptions | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/license-subscriptions/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension |
|||||
| /api/customers/{identifier}/targets/phone-extensions *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{specification}/available *) specification one of: SOURCE|UNCONDITIONAL|BUSY|NOT_AVAILABLE|NOT_REGISTERED|PARALLEL_RING |
GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Inbound trunk numbers |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Outbound trunk numbers |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Outbound trunk numbers > Available |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/outbound-trunk-numbers/available-trunks | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Callforward Global Settings |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-globals | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Callforward Global Settings > Reference |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-globals/{referenceType} *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Callforward Global Settings > Reference > Available |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-globals/{referenceType}/available | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Callforward Profiles |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Callforward Profile > Rules |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Callforward Profile > Rule > Reference |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}/{referenceType} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Callforward Profile > Rule > Reference > Available |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/callforward-profiles/{profileNumber}/rules/{sourceId}/{referenceType}/available *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Call Forwards |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/call-forwards *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Call Forwards > Concrete type |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/call-forwards/{type} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Call Forwards > Available |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/call-forwards/{type}/available *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Function Keys |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/function-keys | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/function-keys/{keyNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/function-keys/available-targets | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/phone-extensions/function-keys/available-targets | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Device |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/devices | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/devices/{uniqueIdentifier} | DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/phone-extensions/available-devices | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Skills |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/skills *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Voice Mail |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/voice-mail | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Phone Extension > Available Internal Outgoing |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/available-internal-outgoings *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/phone-extensions/available-internal-outgoings | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Voice Mail > Announcements |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Phone Extension > Voice Mail > Announcements > Announcement Type |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/voice-mail/announcements/{TEMPORARY|BUSY|UNAVAILABLE|NAME} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/available-cti-info/{NONE|EXPRESS|CRM|nCTIStdWin|nCTIStdWinCRM|nCTIStdMac|nCTIPro} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Routing Prefix Extension |
|||||
| /api/customers/{identifier}/targets/routing-prefix *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/routing-prefix/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Virtual Fax Extension |
|||||
| /api/customers/{identifier}/targets/virtual-fax-extensions *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Virtual Fax Extension > Inbound trunk numbers |
|||||
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Virtual Fax Extension > Outbound trunk numbers |
|||||
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Virtual Fax Extension > Outbound trunk numbers > Active |
|||||
| /api/customers/{identifier}/targets/virtual-fax-extensions/{extensionNumber}/outbound-trunk-numbers/available-trunks | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Queues |
|||||
| /api/customers/{identifier}/targets/queue-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/queue-services/{serviceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Queues > Timeouts |
|||||
| /api/customers/{identifier}/targets/queue-services/{service-number}/timeout | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/queue-services/available-destinations-on-timeout *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Queues > Destination On Rejection |
|||||
| /api/customers/{identifier}/targets/queue-services/{service-number}/destination-on-rejection | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/queue-services/{service-number}/available-destinations-on-rejection *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Queues > Members |
|||||
| /api/customers/{identifier}/targets/queue-services/{serviceNumber}/members | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/queue-services/{serviceNumber}/members/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Queues > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/queue-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Queues > Available Announcements |
|||||
| /api/customers/{identifier}/targets/queue-services/available-general-announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/queue-services/available-music-on-hold-announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Groups |
|||||
| /api/customers/{identifier}/targets/group-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/group-services/{serviceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Groups > Timeouts |
|||||
| /api/customers/{identifier}/targets/group-services/{service-number}/timeout | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/group-services/available-destinations-on-timeout *) | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
Targets > Groups > Members |
|||||
| /api/customers/{identifier}/targets/group-services/{serviceNumber}/members | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/group-services/{serviceNumber}/members/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Groups > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/group-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Skill Services |
|||||
| /api/customers/{identifier}/targets/skill-services | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/skill-services/{serviceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Skill Services > Timeouts |
|||||
| /api/customers/{identifier}/targets/skill-services/{service-number}/timeout | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/skill-services/available-destinations-on-timeout *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Skill Services > Destination On Rejection |
|||||
| /api/customers/{identifier}/targets/skill-services/{service-number}/destination-on-rejection *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/skill-services/{service-number}/available-destinations-on-rejection | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Skill Services > Members |
|||||
| /api/customers/{identifier}/targets/skill-services/{serviceNumber}/members | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/skill-services/{serviceNumber}/members/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Skill Services > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/skill-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/skill-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Skill Services > Skill Login Status |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/skills/login-status | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Skills > Available Announcements |
|||||
| /api/customers/{identifier}/targets/skill-services/available-general-announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/customers/{identifier}/targets/skill-services/available-music-on-hold-announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Conference Services |
|||||
| /api/customers/{identifier}/targets/conference-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/conference-services/{serviceNumber} | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Conference Services > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/conference-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/conference-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > IVR Services |
|||||
| /api/customers/{identifier}/targets/ivr-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > IVR Services > Timeouts |
|||||
| /api/customers/{identifier}/targets/ivr-services/{service-number}/timeout | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/ivr-services/available-destinations-on-timeout *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > IVR Services > Key Assignments |
|||||
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber}/key-assignments | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber}/key-assignments/{number} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber}/key-assignments/target-available-destinations *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > IVR Services > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/ivr-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > IVR > Available Announcements |
|||||
| /api/customers/{identifier}/targets/ivr-services/available-general-announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Time Control Services |
|||||
| /api/customers/{identifier}/targets/time-control-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/time-control-services/{serviceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OEPRATOR | ADMIN | |
| /api/customers/{identifier}/targets/time-control-services/available-destinations *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Targets > Time Control Services > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/time-control-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/time-control-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Frontdesk Services |
|||||
| /api/customers/{identifier}/targets/frontdesk-services *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/frontdesk-services/{serviceNumber} | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Frontdesk Services > Inbound Trunk Numbers |
|||||
| /api/customers/{identifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/frontdesk-services/{serviceNumber}/inbound-trunk-numbers/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Targets > Frontdesk Services > Frontdesk Targets |
|||||
| /api/customers/{identifier}/targets/frontdesk-services/{serviceNumber}/target | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/frontdesk-services/{serviceNumber}/target/{targetServiceNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Speed Dials |
|||||
| /api/customers/{identifier}/speed-dials *) | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/speed-dials/{speedDialId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Phone Books |
|||||
| /api/customers/{identifier}/phone-books *) | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/phone-books/{phoneBookId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Phone Books > Visibilities |
|||||
| /api/customers/{identifier}/phone-books/{phoneBookId}/visibilities | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/phone-books/{phoneBookId}/visibilities/{extensionNumber} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Phone Books > Visibilities > Available Phone Extensions |
|||||
| /api/customers/{identifier}/phone-books/{phoneBookId}/visibilities/available-phone-extensions | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
Lync > Lync Gateways (for Skype-For-Business) |
|||||
| /api/customers/{identifier}/lync/gateways | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/lync/gateways/{lyncGatewayId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Lync > Lync Sites (for Skype-For-Business and MSTEAMS) |
|||||
| /api/customers/{identifier}/lync/sites | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/lync/sites/{lyncSiteId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Lync > Lync Options (for Skype-For-Business and MSTEAMS) |
|||||
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/lync | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/targets/phone-extensions/{extensionNumber}/lync/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Lync > Lync Devices (for Skype-For-Business and MSTEAMS) |
|||||
| /api/customers/{identifier}/devices/lync/{id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Announcements |
|||||
| /api/customers/{identifier}/announcements | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/customers/{identifier}/announcements/{announcementId} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Device Types |
|||||
| /api/device-types *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/device-types/{deviceTypeName} | GET | CUSTOMER | SYSTEM-INTEGRATOR | OPERATOR | ADMIN |
Device Types > Firmwares |
|||||
| /api/device-types/{deviceTypeName}/firmwares | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/device-types/{deviceTypeName}/firmwares/{releaseVersion} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Account |
|||||
| /api/accounts | POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/accounts/{account-salesforce-id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Account > Site |
|||||
| /api/accounts/{account-salesforce-id}/sites | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/accounts/{account-salesforce-id}/sites/{site-salesforce-id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Sip Servers |
|||||
| /api/sip-servers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| POST | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| /api/sip-servers/{sip-server-id} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| PUT | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
| DELETE | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN | |
Pbx Groups |
|||||
| /api/pbx-groups *) | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/pbx-groups/{pbx-group-name} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Directcall numbers |
|||||
| /api/directcall-numbers | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/directcall-numbers/{number} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Timezones |
|||||
| /api/time-zones | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/time-zones/{timezone} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Contract Types |
|||||
| /api/contract-types | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
| /api/contract-types/{contracttype} | GET | CUSTOMER | SYSTEM INTEGRATOR | OPERATOR | ADMIN |
Devices |
|||||
| /api/devices | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
Devices |
|||||
| /api/devices/validate-macaddress | POST | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
Tenants |
|||||
| /api/tenants/{tenantIdentifier}/audit/type | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |
| /api/tenants/{tenantIdentifier}/audit | GET | CUSTOMER | SYSTEMINTEGRATOR | OPERATOR | ADMIN |