Child pages
  • Gateways Rest
Skip to end of metadata
Go to start of metadata

View all gateways

Available in 14 starting with 14.10

Resource URI: /gateways

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

id

Gateway unique identification number.

name

Gateway name.

description

Short description provided by the user.

model

The model related information is similar to the one described under /model.

enabled

Displays True if it is enabled or False if it is disabled.

address

Gateway address.

addressPort

Address port number.

outboundPort

Outbound port number.

addressTransport


shared


useInternalBridge

Displays True if it is enabled or False if it is disabled.

anonymus

Displays True if it is enabled or False if it is disabled.

ignoreUserInfo


transformUserExtensions


keepDigits


Specific Response Codes: N/A

HTTP Method: GET

Retrieves all the gateways in the database.

Example: XML version

<Gateways><Gateway>

<id>%s</id>

<name>myGateway</name>"

"<description>myDesc</description>

<Model><modelId>acmeGatewayStandard</modelId>"

"<label>Acme1000</label>

<vendor>acme</vendor>

</Model>

<enabled>true</enabled>

<address>1.1.1.1</address>

<addressPort>0</addressPort>"

"<outboundPort>5060</outboundPort>

<addressTransport>none</addressTransport>"

"<shared>true</shared>

<useInternalBridge>true</useInternalBridge>"

"<CallerAliasInfo><anonymous>false</anonymous>

<ignoreUserInfo>false</ignoreUserInfo>

<transformUserExtension>false</transformUserExtension>

<keepDigits>0</keepDigits>

</CallerAliasInfo>"

"</Gateway></Gateways>"

JSON format

{\"gateways\":[{\"id\":%s,\"name\":\"myGateway\",\"serialNo\":null,\"deviceVersion\":null,\"description\":\"myDesc\","

"\"model\":{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\","

"\"versions\":null},\"enabled\":true,\"address\":\"1.1.1.1\",\"addressPort\":0,\"outboundAddress\":null,\"outboundPort\":5060,"

"\"addressTransport\":\"none\",\"prefix\":null,\"shared\":true,\"useInternalBridge\":true,\"branch\":null,"

"\"callerAliasInfo\":{\"defaultCallerAlias\":null,\"anonymous\":false,\"ignoreUserInfo\":false,\"transformUserExtension\":false,"

"\"addPrefix\":null,\"keepDigits\":0,\"displayName\":null,\"urlParameters\":null}}]}

Unsupported HTTP Method: PUT, POST, DELETE

Filter gateways by model

Available in 14 starting with 14.10

Resource URI: /gateways/models

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

model

Gateway model.

label

Gateway label.

vendor

Gateway model vendor.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the models of all the gateways in the database.

Example: XML format

"<Models><Model><modelId>acmeGatewayStandard</modelId><label>Acme 1000</label><vendor>acme</vendor></Model>"

"<Model><modelId>genericGatewayStandard</modelId><label>Unmanaged gateway</label></Model>"

"<Model><modelId>sipTrunkStandard</modelId><label>SIP trunk</label></Model></Models>"

JSON format

"{\"models\":[{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\",\"versions\":null},"

"{\"modelId\":\"genericGatewayStandard\",\"label\":\"Unmanaged gateway\",\"vendor\":null,\"versions\":null},"

"{\"modelId\":\"sipTrunkStandard\",\"label\":\"SIP trunk\",\"vendor\":null,\"versions\":null}]}"

Unsupported HTTP Method: PUT, POST, DELETE


View or modify gateway ID

Available in 14 starting with 14.10

Resource URI: /gateways/{gatewayId}

Default Resource Properties

The resource is represented by the following properties when the GET request is performed:

Property

Description

gateway

The gateway related information is similar to the one described under /gateway.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves information on the gateway with the specified ID.

Example: XML format

<Gateway><id>%s</id><name>myGateway</name><description>myDesc</description>"

"<Model><modelId>acmeGatewayStandard</modelId><label>Acme 1000</label><vendor>acme</vendor></Model>"

"<enabled>true</enabled><address>1.1.1.1</address><addressPort>0</addressPort><outboundPort>5060</outboundPort>"

"<addressTransport>none</addressTransport><shared>true</shared><useInternalBridge>true</useInternalBridge>"

"<CallerAliasInfo><anonymous>false</anonymous><ignoreUserInfo>false</ignoreUserInfo>"

"<transformUserExtension>false</transformUserExtension><keepDigits>0</keepDigits></CallerAliasInfo></Gateway>"

JSON format

"{\"id\":%s,\"name\":\"myGateway\",\"serialNo\":null,\"deviceVersion\":null,\"description\":\"myDesc\","

+ "\"model\":{\"modelId\":\"acmeGatewayStandard\",\"label\":\"Acme 1000\",\"vendor\":\"acme\",\"versions\":null},"

"\"enabled\":true,\"address\":\"1.1.1.1\",\"addressPort\":0,\"outboundAddress\":null,\"outboundPort\":5060,"

"\"addressTransport\":\"none\",\"prefix\":null,\"shared\":true,\"useInternalBridge\":true,\"branch\":null,"

"\"callerAliasInfo\":{\"defaultCallerAlias\":null,\"anonymous\":false,\"ignoreUserInfo\":false,"

"\"transformUserExtension\":false,\"addPrefix\":null,\"keepDigits\":0,\"displayName\":null,\"urlParameters\":null}}"

HTTP Method: PUT

Updates gateway with the specified ID. Uses the same XML as for creation.

HTTP Method: POST

Creates new gateway with the specified ID.

HTTP Method: DELETE

Removes gateway with the specified ID.

Unsupported HTTP Method: N/A

View all settings of a gateway ID

Available in 14 starting with 14.10

Resource URI: /gateways/{gatewayId}/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

path

Path to the setting.

type

Setting type. Possible options are string, boolean or enum.

options

Available setting options.

value

The current selected option of the setting.

defaultValue

The default value of the setting.

label

Setting label.

description

Short description provided by the user.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the settings for the specified phone models in the gateway ID.

Example: XML format

<Settings>

<Setting>

<path>SIP_general/PRACKMode</path>

<type>enum</type>

<options>

<entry>

<key>2</key>

<value>Required</value>

</entry>

<entry>

<key>1</key>

<value>Supported</value>

</entry>

<entry>

<key>0</key>

<value>Disabled</value>

</entry>

</options>

<value>1</value>

<defaultValue>1</defaultValue>

<label>PRACK Mode</label>

</Setting>

<Setting>

<path>SIP_general/ChannelSelectMode</path>

<type>enum</type>

<options>

<entry>

<key>3</key>

<value>Cyclic Descending</value>

</entry>

<entry>

<key>2</key>

<value>Ascending</value>

</entry>

<entry>

<key>1</key>

<value>Cyclic Ascending</value>

</entry>

<entry>

<key>0</key>

<value>By phone number</value>

</entry>

<entry>

<key>6</key>

<value>Calling Party Number</value>

</entry>

<entry>

<key>5</key>

<value>Number + cyclic Ascending</value>

</entry>

<entry>

<key>4</key>

<value>Descending</value>

</entry>

</options>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Channel Select Mode</label>

</Setting>

<Setting>

<path>SIP_general/EnableEarlyMedia</path>

<type>boolean</type>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Enable Early Media</label>

</Setting>

<Setting>

<path>SIP_general/AssertedIDMode</path>

<type>enum</type>

<options>

<entry>

<key>2</key>

<value>P-Preferred</value>

</entry>

<entry>

<key>1</key>

<value>P-Asserted</value>

</entry>

<entry>

<key>0</key>

<value>Disabled</value>

</entry>

</options>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Asserted ID Mode</label>

<description>The Asserted ID mode defines the header that is used in the generated INVITE request. The header also depends on the calling Privacy: allowed or restricted.</description>

</Setting>

<Setting>

<path>SIP_general/UseTelURIForAssertedID</path>

<type>boolean</type>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Tel URI for Asserted Identity</label>

</Setting>

<Setting>

<path>SIP_general/IsFaxUsed</path>

<type>enum</type>

<options>

<entry>

<key>3</key>

<value>T.38 + Passthru</value>

</entry>

<entry>

<key>2</key>

<value>Passthru (G711)</value>

</entry>

<entry>

<key>1</key>

<value>T.38</value>

</entry>

<entry>

<key>0</key>

<value>No SIP signaling for fax</value>

</entry>

</options>

<value>3</value>

<defaultValue>3</defaultValue>

<label>Fax Signaling</label>

</Setting>

<Setting>

<path>SIP_general/DetFaxOnAnswerTone</path>

<type>enum</type>

<options>

<entry>

<key>1</key>

<value>T.38 on CED</value>

</entry>

<entry>

<key>0</key>

<value>T.38 on Preamble</value>

</entry>

</options>

<value>0</value>

<defaultValue>0</defaultValue>

<label>Detect Fax on Answer Tone</label>

</Setting>

</setting>

JSON format

{

settings:

{

path: "SIP_general/PRACKMode"

type: "enum"

options: {

0: "Disabled"

1: "Supported"

2: "Required"

}-

value: "1"

defaultValue: "1"

label: "PRACK Mode"

description: null

}-

{

path: "SIP_general/ChannelSelectMode"

type: "enum"

options: {

0: "By phone number"

1: "Cyclic Ascending"

2: "Ascending"

3: "Cyclic Descending"

4: "Descending"

5: "Number + cyclic Ascending"

6: "Calling Party Number"

}-

value: "1"

defaultValue: "1"

label: "Channel Select Mode"

description: null

}-

{

path: "SIP_general/EnableEarlyMedia"

type: "boolean"

options: null

value: "1"

defaultValue: "1"

label: "Enable Early Media"

description: null

}-

{

path: "SIP_general/AssertedIDMode"

type: "enum"

options: {

0: "Disabled"

1: "P-Asserted"

2: "P-Preferred"

}-

value: "0"

defaultValue: "0"

label: "Asserted ID Mode"

description: "The Asserted ID mode defines the header that is used in the generated INVITE request. The header also depends on the calling Privacy: allowed or restricted."

}-

{

path: "SIP_general/UseTelURIForAssertedID"

type: "boolean"

options: null

value: "0"

defaultValue: "0"

label: "Tel URI for Asserted Identity"

description: null

}-

{

path: "SIP_general/IsFaxUsed"

type: "enum"

options: {

0: "No SIP signaling for fax"

1: "T.38"

2: "Passthru (G711)"

3: "T.38 + Passthru"

}-

value: "3"

defaultValue: "3"

label: "Fax Signaling"

description: null

}-

{

path: "SIP_general/DetFaxOnAnswerTone"

type: "enum"

options: {

0: "T.38 on Preamble"

1: "T.38 on CED"

}-

value: "0"

defaultValue: "0"

label: "Detect Fax on Answer Tone"

description: null

}-

{

path: "SIP_general/SIPTransportType"

type: "enum"

options: {

0: "UDP"

1: "TCP"

2: "TLS"

}-

value: "0"

defaultValue: "0"

label: "SIP Transport Type"

description: null

}-

{

path: "SIP_general/LocalSIPPort"

type: "string"

options: null

value: "5060"

defaultValue: "5060"

label: "UDP SIP Port"

description: "UDP Port for SIP signaling"

}-

{

path: "SIP_general/TCPLocalSIPPort"

type: "string"

options: null

value: "5060"

defaultValue: "5060"

label: "TCP SIP Port"

description: "TCP Port for SIP signaling"

}-

{

path: "SIP_general/TLSLocalSIPPort"

type: "string"

options: null

value: "5061"

defaultValue: "5061"

label: "TLS SIP Port"

description: "TLS Port for SIP signaling"

}

}

Unsupported HTTP Method: PUT, POST, DELETE


View or modify a setting for phone models in a gateway ID

Available in 14 starting with 14.10

Resource URI: /gateways/{gatewayId}/settings/{path:.*}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

gateway

The gateway related information is similar to the one described under /gateway.

Specific Response Codes: N/A

HTTP Method: GET

Retrieve the setting specified in the path for the phone models in the gateway ID.

Example: XML format

<Setting>

<path>SIP_general/EnableEarlyMedia</path>

<type>boolean</type>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Enable Early Media</label>

</Setting>

JSON format

{

path: "SIP_general/EnableEarlyMedia"

type: "boolean"

options: null

value: "1"

defaultValue: "1"

label: "Enable Early Media"

description: null

}

HTTP Method: PUT

Updates the setting specified in the path for the phone models in the gateway ID.PUT data is plain text.

HTTP Method: DELETE

Deletes the setting specified in the path for the phone models in the gateway ID.

Unsupported HTTP Method: POST


View ports for a gateway ID

Available in 14 starting with 14.10

Resource URI: /gateways/{gatewayId}/ports

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description





Specific Response Codes: N/A

HTTP Method: GET

Retrieves the ports of the gateway with the specified ID.

HTTP Method: PUT

Updates the ports of the gateway with the specified ID. PUT data is plain text.

HTTP Method: DELETE

Deletes the ports of the gateway with the specified ID.

Unsupported HTTP Method: POST


View port settings for a gateway ID

Available in 14 starting with 14.10

Resource URI: /gateway/{gatewayId}/port/{portId}/settings

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

setting

The port setting related information is similar to the one described under /gateway/settings.

Specific Response Codes: N/A

HTTP Method: GET

View port settings for the gateway with the specified ID.

Example: XML format

<Settings>

<Setting>

<path>Port/AutomaticDialing</path>

<type>boolean</type>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Automatic Dialing</label>

<description>If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below.</description>

</Setting>

<Setting>

<path>Port/Extension</path>

<type>string</type>

<value>operator</value>

<defaultValue>operator</defaultValue>

<label>Extension</label>

<description>Specify the destination for incoming calls on this PSTN line, such as an auto-attendant, a hunt group, an ACD queue, or any internal extension, user or alias.</description>

</Setting>

</Settings>

JSON format

{

settings: [2]

0: {

path: "Port/AutomaticDialing"

type: "boolean"

options: null

value: "1"

defaultValue: "1"

label: "Automatic Dialing"

description: "If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below."

}-

1: {

path: "Port/Extension"

type: "string"

options: null

value: "operator"

defaultValue: "operator"

label: "Extension"

description: "Specify the destination for incoming calls on this PSTN line, such as an auto-attendant, a hunt group, an ACD queue, or any internal extension, user or alias."

}-

-

}

HTTP Method: PUT

Updates the port settings for the gateway with the specified ID. PUT data is plain text.

HTTP Method: DELETE

Deletes the port settings for the gateway with the specified ID.

Unsupported HTTP Method: POST


View or modify port settings

Available in 14 starting with 14.10

Resource URI: /gateway/{gatewayId}/port/{portId}/settings/{path:.*}

Default Resource Properties:

The resource is represented by the following properties when the GET request is performed:

Property

Description

setting

The port setting related information is similar to the one described under /gateway/settings.

Specific Response Codes: N/A

HTTP Method: GET

Retrieves the port settings of the gateway with the specified ID.

Example: XML format

<Setting>

<path>Port/AutomaticDialing</path>

<type>boolean</type>

<value>1</value>

<defaultValue>1</defaultValue>

<label>Automatic Dialing</label>

<description>If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below.</description>

</Setting>

JSON format

{

path: "Port/AutomaticDialing"

type: "boolean"

options: null

value: "1"

defaultValue: "1"

label: "Automatic Dialing"

description: "If enabled calls received on this PSTN line will be automatically sent to the destination (extension or user) specified below."

}

HTTP Method: PUT

Updates the settings of the port. PUT data is plain text.
HTTP Method: DELETE
Deletes the settings of the port.

Unsupported HTTP Method: POST

  • No labels