REST API Method: POST /rest/relay

Modifies the digital (DS1) port pair relay on the SBC system.

URL:

https://192.168.0.111/rest/relay

HTTP Method

POST

Requires Authentication:

true

relay - REST API Methods

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
digitalRelayStateNoYesEnum0Possible 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.
analogSysRelayNoYesEnum0Possible 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.

Helpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

  • No labels