REST API Method: POST /rest/relay
Modifies the digital (DS1) port pair relay on the Sonus SBC 1000/2000 system.
URL:
https://134.56.227.163/rest/relay
HTTP Method
POST
Requires Authentication:
true
Parameters
| Parameter Name | Required | Service Affecting | Data Type | Default Value | Possible Values | Description |
|---|
| digitalRelayState | No | Yes | Enum | 0 | Possible values: - 0 - rcsOnline
- 1 - rcsPassThru
- 2 - rcsPowerdownPassThru
| Configures the digital relay state - rcsOnline - each DS1 pair of ports are connected to the unit and capable of originating and terminating PSTN calls.
- rcsPassThru - each DS1 part of ports are in pass through and not connected to the unit.
- rcsPowerdownPassThru - each pair of ports is cross-connected when the unit's power is lost or powered off.
|
|---|
| analogSysRelay | No | Yes | Enum | 0 | Possible values: - 0 - rcsOnline
- 1 - rcsPassThru
- 2 - rcsPowerdownPassThru
| Configures the digital relay state - rcsOnline - each Relay FXS and FXO port pairs are connected to the unit and capable of originating and terminating PSTN calls.
- rcsPassThru - each Relay FXS and FXO port pairs are in pass through and not connected to the unit.
|
|---|
| Tip |
|---|
|
The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource |
| Code Block |
|---|
|
Put code example here |
Response:
| Code Block |
|---|
|
Put Code response here |