A sip subscriber can be any device (phone, gateway, Opti Client, etc.) or a virtual device. Sip subscribers are identified by their id (which in most cases is the mac address) or their e164 number (which may not be unique). If the e164 is not unique use cases based on th e164 number will fail.
Overview | The user submits the e164 basic number for the sip subscriber to add to DLS. In addition, the name of a device profile containing device configurations is submitted. DLS creates a virtual device which will be configured using the device profile data. Then the user will be informed whether adding the new subscriber succeeded or failed. |
Preconditions |
The subscriber to add is unknown to DLS. The device profile used to configure the subscriber is known to DLS. |
Postconditions | The supscriber is known to DLS, either as real or as virtual device and it is configured using the device profile. |
API reference | e164AddSipSubscriber |
Overview | The user submits the e164 basic number for the sip subscriber to modify.
In addition, the name of a device profile containing new device configurations
is submitted. DLS searches the device and changes the configuration using the
new device profile data. If, in addition, the device is a real device then DSL
creates a job which configures the device according to the new configuration.
The user will be informed whether modifying the subscriber succeeded or failed,
and whether a job was created.
If a job was created, DLS also comes up with a job id, which identifies the job uniquely. Using this job id, the user can check the status (running, finished, active, timed out) of the job until the job is finished. |
Preconditions |
The subscriber to modify is known to DLS, eiher as real or as virtual device. The device profile used to configure the subscriber is known to DLS. |
Postconditions | The supscriber is configured using the new device profile. If, in addition, the subscriber is a real device, then a job will be created to configure that device according to the new configuration. |
API reference | e164ModifySipSubscriber |
Overview |
The user asks DLS to present a description of all devices for which a
key configuration is possible. SUbsequently, the user asks DLS to present
a dewccription of all functions that can be put on a special device.
Then the user submits a configuration to DLS including the e164 basic number for the device, layout configuration data, and key function configuration data. DLS internally modifies the key layout configuration for the device according to the submitted data. Moreover, if the device si a rela device DLS cerates a job which configure the device with the new configuration. The user will be informed whether modifying the key layout succeeded or failed, and whether a job was created. If a job was created, DLS also comes up with a job id, which identifies the job uniquely. Using this job id, the user can check the status (running, finished, active, timed out) of the job until the job is finished. |
Preconditions |
The subscriber to modify is known to DLS, eiher as real or as virtual device. The key layout configuration is allowed for the device. |
Postconditions | The supscriber is configured according to the submitted key layout data. If, in addition, the subscriber is a real device, then a job will be created to configure that device according to the new configuration. |
API reference | e164ModifyKeyLayout |
Overview | The user submits the e164 basic number for the sip subscriber to delete. DLS searches the device and deletes it from DLS. The user will be informed whether deleting the subscriber succeeded or failed. |
Preconditions | The subscriber to delete is known to DLS, eiher as real or as virtual device. |
Postconditions | The supscriber is unknown to DLS. |
Overview | The user submits an e164 pattern and a query type. The query determines which data of the found devices will be presented to the user. DLS searches all devices which e164 basic number matches the e164 pattern, and presents the list to the user. |
Preconditions | none. |
Postconditions | none. |