The System Manager Web Services interface for routing and dial plan management provides remote programmatic access for querying, creating, and deleting all Session Manager routing domain data. The routing data that the service accesses and modifies is the same routing data supported by the routing bulk import and administration GUI. The primary routing domain data types are:
Domains
Locations
Adaptations
SIP Entities
Entity Links
Time Ranges
Routing Policies
Dial Patterns
Regular Expression data
The System Manager Web Services interface supports the following:
Administration
User registration
Implicit users
The System Manager Web Services API enforces the same level of data integrity as the GUI and import interfaces. The API components enforce the same validation logic the GUI and Import interfaces use.
Use the System Manager Web Services interface for provisioning only. Do not use the Web Service API for real-time application access or SIP application integration. The System Manager Web Service API is appropriate for automating normal administrative tasks and has the same administration data propagation delay to Session Managers as the Routing GUI and bulk import interfaces. The System Manager Web Services API also allows re-booting of SIP phone.
The System Manager Web Services API uses RESTful current best practices. The service provides for XML payloads by default but can optionally support JSON payloads.
Users can select any desired REST client implementation technology. Users must have Web Service development level skills for REST client development.
The System Manager Web Services interface documentation includes a programmer's guide, detailed schema definition, and examples and samples.
