create new entry
POST /api/rest/admin/gateways
Parameters
| Name |
Description |
|
data[type]
|
Resource type (gateways)
|
|
data[attributes][name]
|
Name
|
|
data[attributes][enabled]
|
Enabled
|
|
data[attributes][priority]
|
Priority
|
|
data[attributes][weight]
|
Weight
|
|
data[attributes][acd-limit]
|
Acd limit
|
|
data[attributes][asr-limit]
|
Asr limit
|
|
data[attributes][allow-origination]
|
Allow origination
|
|
data[attributes][allow-termination]
|
Allow termination
|
|
data[attributes][sst-enabled]
|
Sst enabled
|
|
data[attributes][host]
|
Host
|
|
data[attributes][port]
|
Port
|
|
data[attributes][resolve-ruri]
|
Resolve ruri
|
|
data[attributes][diversion-domain]
|
Diversion domain
|
|
data[attributes][diversion-rewrite-rule]
|
Diversion rewrite rule
|
|
data[attributes][diversion-rewrite-result]
|
Diversion rewrite result
|
|
data[attributes][src-name-rewrite-rule]
|
Src name rewrite rule
|
|
data[attributes][src-name-rewrite-result]
|
Src name rewrite result
|
|
data[attributes][src-rewrite-rule]
|
Src rewrite rule
|
|
data[attributes][src-rewrite-result]
|
Src rewrite result
|
|
data[attributes][dst-rewrite-rule]
|
Dst rewrite rule
|
|
data[attributes][dst-rewrite-result]
|
Dst rewrite result
|
|
data[attributes][auth-enabled]
|
Auth enabled
|
|
data[attributes][auth-user]
|
Auth user
|
|
data[attributes][auth-password]
|
Auth password
|
|
data[attributes][auth-from-user]
|
Auth from user
|
|
data[attributes][auth-from-domain]
|
Auth from domain
|
|
data[attributes][term-use-outbound-proxy]
|
Term use outbound proxy
|
|
data[attributes][term-force-outbound-proxy]
|
Term force outbound proxy
|
|
data[attributes][term-outbound-proxy]
|
Term outbound proxy
|
|
data[attributes][term-next-hop-for-replies]
|
Term next hop for replies
|
|
data[attributes][term-next-hop]
|
Term next hop
|
|
data[attributes][term-append-headers-req]
|
Term append headers req
|
|
data[attributes][orig-append-headers-req]
|
Orig append headers req
|
|
data[attributes][orig-append-headers-reply]
|
Orig append headers reply
|
|
data[attributes][sdp-alines-filter-list]
|
Sdp alines filter list
|
|
data[attributes][ringing-timeout]
|
Ringing timeout
|
|
data[attributes][relay-options]
|
Relay options
|
|
data[attributes][relay-reinvite]
|
Relay reinvite
|
|
data[attributes][relay-hold]
|
Relay hold
|
|
data[attributes][relay-prack]
|
Relay prack
|
|
data[attributes][relay-update]
|
Relay update
|
|
data[attributes][suppress-early-media]
|
Suppress early media
|
|
data[attributes][fake-180-timer]
|
Fake 180 timer
|
|
data[attributes][transit-headers-from-origination]
|
Transit headers from origination
|
|
data[attributes][transit-headers-from-termination]
|
Transit headers from termination
|
|
data[attributes][sip-interface-name]
|
Sip interface name
|
|
data[attributes][allow-1xx-without-to-tag]
|
Allow 1xx without to tag
|
|
data[attributes][sip-timer-b]
|
Sip timer b
|
|
data[attributes][dns-srv-failover-timer]
|
Dns srv failover timer
|
|
data[attributes][proxy-media]
|
Proxy media
|
|
data[attributes][single-codec-in-200ok]
|
Single codec in 200ok
|
|
data[attributes][force-symmetric-rtp]
|
Force symmetric rtp
|
|
data[attributes][symmetric-rtp-nonstop]
|
Symmetric rtp nonstop
|
|
data[attributes][force-dtmf-relay]
|
Force dtmf relay
|
|
data[attributes][rtp-ping]
|
Rtp ping
|
|
data[attributes][rtp-timeout]
|
Rtp timeout
|
|
data[attributes][filter-noaudio-streams]
|
Filter noaudio streams
|
|
data[attributes][rtp-relay-timestamp-aligning]
|
Rtp relay timestamp aligning
|
|
data[attributes][rtp-force-relay-cn]
|
Rtp force relay cn
|
|
data[attributes][sip-schema-id]
|
Sip schema id
|
|
data[attributes][preserve-anonymous-from-domain]
|
Preserve anonymous from domain
|
|
data[attributes][registered-aor-mode-id]
|
Registered aor mode id
|
|
data[attributes][origination-capacity]
|
Origination capacity
|
|
data[attributes][termination-capacity]
|
Termination capacity
|
|
data[attributes][incoming-auth-username]
|
Incoming auth username
|
|
data[attributes][incoming-auth-password]
|
Incoming auth password
|
|
data[attributes][force-cancel-routeset]
|
Force cancel routeset
|
|
data[relationships][contractor]
|
Contractor
|
|
data[relationships][codec-group]
|
Codec group
|
|
data[relationships][sdp-c-location]
|
Sdp c location
|
|
data[relationships][sensor-level]
|
Sensor level
|
|
data[relationships][dtmf-receive-mode]
|
Dtmf receive mode
|
|
data[relationships][dtmf-send-mode]
|
Dtmf send mode
|
|
data[relationships][rx-inband-dtmf-filtering-mode]
|
Rx inband dtmf filtering mode
|
|
data[relationships][tx-inband-dtmf-filtering-mode]
|
Tx inband dtmf filtering mode
|
|
data[relationships][rel100-mode]
|
Rel100 mode
|
|
data[relationships][session-refresh-method]
|
Session refresh method
|
|
data[relationships][transport-protocol]
|
Transport protocol
|
|
data[relationships][sdp-alines-filter-type]
|
Sdp alines filter type
|
|
data[relationships][term-proxy-transport-protocol]
|
Term proxy transport protocol
|
|
data[relationships][orig-proxy-transport-protocol]
|
Orig proxy transport protocol
|
|
data[relationships][network-protocol-priority]
|
Network protocol priority
|
|
data[relationships][media-encryption-mode]
|
Media encryption mode
|
|
data[relationships][term-disconnect-policy]
|
Term disconnect policy
|
|
data[relationships][orig-disconnect-policy]
|
Orig disconnect policy
|
|
data[relationships][gateway-group]
|
Gateway group
|
|
data[relationships][diversion-send-mode]
|
Diversion send mode
|
|
data[relationships][pop]
|
Pop
|
|
data[relationships][sensor]
|
Sensor
|
Request
Headers
Route
POST /api/rest/admin/gateways
Body
{"data":{"type":"gateways","attributes":{"name":"name","enabled":true,"priority":1,"weight":900,"acd-limit":0.0,"asr-limit":0.0,"host":"test.example.com"},"relationships":{"contractor":{"data":{"type":"contractors","id":86}},"codec-group":{"data":{"type":"codec-groups","id":19}},"sdp-c-location":{"data":{"type":"sdp-c-locations","id":2}},"sensor-level":{"data":{"type":"sensor-levels","id":1}},"dtmf-receive-mode":{"data":{"type":"dtmf-receive-modes","id":1}},"dtmf-send-mode":{"data":{"type":"dtmf-send-modes","id":1}},"rx-inband-dtmf-filtering-mode":{"data":{"type":"gateway-inband-dtmf-filtering-modes","id":3}},"tx-inband-dtmf-filtering-mode":{"data":{"type":"gateway-inband-dtmf-filtering-modes","id":2}},"rel100-mode":{"data":{"type":"gateway-rel100-modes","id":1}},"session-refresh-method":{"data":{"type":"session-refresh-methods","id":1}},"transport-protocol":{"data":{"type":"transport-protocols","id":1}},"sdp-alines-filter-type":{"data":{"type":"filter-types","id":0}},"term-proxy-transport-protocol":{"data":{"type":"transport-protocols","id":1}},"orig-proxy-transport-protocol":{"data":{"type":"transport-protocols","id":1}},"network-protocol-priority":{"data":{"type":"gateway-network-protocol-priorities","id":3}},"media-encryption-mode":{"data":{"type":"gateway-media-encryption-modes","id":2}}}}}
Response
Headers
Status
201 Created
Body
{
"data": {
"id": "25",
"type": "gateways",
"links": {
"self": "http://example.org/api/rest/admin/gateways/25"
},
"attributes": {
"name": "name",
"enabled": true,
"priority": 1,
"weight": 900,
"acd-limit": 0.0,
"asr-limit": 0.0,
"allow-origination": true,
"allow-termination": true,
"sst-enabled": false,
"host": "test.example.com",
"port": null,
"resolve-ruri": false,
"diversion-domain": null,
"diversion-rewrite-rule": null,
"diversion-rewrite-result": null,
"src-name-rewrite-rule": null,
"src-name-rewrite-result": null,
"src-rewrite-rule": null,
"src-rewrite-result": null,
"dst-rewrite-rule": null,
"dst-rewrite-result": null,
"auth-enabled": false,
"auth-user": null,
"auth-password": null,
"auth-from-user": null,
"auth-from-domain": null,
"term-use-outbound-proxy": false,
"term-force-outbound-proxy": false,
"term-outbound-proxy": null,
"term-next-hop-for-replies": false,
"term-next-hop": null,
"term-append-headers-req": [
],
"orig-append-headers-req": [
],
"orig-append-headers-reply": [
],
"sdp-alines-filter-list": null,
"ringing-timeout": null,
"relay-options": false,
"relay-reinvite": false,
"relay-hold": false,
"relay-prack": false,
"relay-update": false,
"suppress-early-media": false,
"fake-180-timer": null,
"transit-headers-from-origination": null,
"transit-headers-from-termination": null,
"sip-interface-name": null,
"allow-1xx-without-to-tag": false,
"sip-timer-b": 8000,
"dns-srv-failover-timer": 2000,
"proxy-media": true,
"single-codec-in-200ok": false,
"force-symmetric-rtp": true,
"symmetric-rtp-nonstop": false,
"force-dtmf-relay": false,
"rtp-ping": false,
"rtp-timeout": 30,
"filter-noaudio-streams": false,
"rtp-relay-timestamp-aligning": false,
"rtp-force-relay-cn": true,
"preserve-anonymous-from-domain": false,
"registered-aor-mode-id": 0,
"incoming-auth-username": null,
"incoming-auth-password": null,
"origination-capacity": null,
"termination-capacity": null,
"force-cancel-routeset": false,
"sip-schema-id": 1
},
"relationships": {
"contractor": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/contractor",
"related": "http://example.org/api/rest/admin/gateways/25/contractor"
},
"data": {
"type": "contractors",
"id": "86"
}
},
"session-refresh-method": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/session-refresh-method",
"related": "http://example.org/api/rest/admin/gateways/25/session-refresh-method"
},
"data": {
"type": "session-refresh-methods",
"id": "1"
}
},
"sdp-alines-filter-type": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/sdp-alines-filter-type",
"related": "http://example.org/api/rest/admin/gateways/25/sdp-alines-filter-type"
},
"data": {
"type": "filter-types",
"id": "0"
}
},
"term-disconnect-policy": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/term-disconnect-policy",
"related": "http://example.org/api/rest/admin/gateways/25/term-disconnect-policy"
},
"data": null
},
"orig-disconnect-policy": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/orig-disconnect-policy",
"related": "http://example.org/api/rest/admin/gateways/25/orig-disconnect-policy"
},
"data": null
},
"gateway-group": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/gateway-group",
"related": "http://example.org/api/rest/admin/gateways/25/gateway-group"
},
"data": null
},
"diversion-send-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/diversion-send-mode",
"related": "http://example.org/api/rest/admin/gateways/25/diversion-send-mode"
},
"data": {
"type": "gateway-diversion-send-modes",
"id": "1"
}
},
"pop": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/pop",
"related": "http://example.org/api/rest/admin/gateways/25/pop"
},
"data": null
},
"codec-group": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/codec-group",
"related": "http://example.org/api/rest/admin/gateways/25/codec-group"
},
"data": {
"type": "codec-groups",
"id": "19"
}
},
"sdp-c-location": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/sdp-c-location",
"related": "http://example.org/api/rest/admin/gateways/25/sdp-c-location"
},
"data": {
"type": "sdp-c-locations",
"id": "2"
}
},
"sensor": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/sensor",
"related": "http://example.org/api/rest/admin/gateways/25/sensor"
},
"data": null
},
"sensor-level": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/sensor-level",
"related": "http://example.org/api/rest/admin/gateways/25/sensor-level"
},
"data": {
"type": "sensor-levels",
"id": "1"
}
},
"dtmf-receive-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/dtmf-receive-mode",
"related": "http://example.org/api/rest/admin/gateways/25/dtmf-receive-mode"
},
"data": {
"type": "dtmf-receive-modes",
"id": "1"
}
},
"dtmf-send-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/dtmf-send-mode",
"related": "http://example.org/api/rest/admin/gateways/25/dtmf-send-mode"
},
"data": {
"type": "dtmf-send-modes",
"id": "1"
}
},
"transport-protocol": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/transport-protocol",
"related": "http://example.org/api/rest/admin/gateways/25/transport-protocol"
},
"data": {
"type": "transport-protocols",
"id": "1"
}
},
"term-proxy-transport-protocol": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/term-proxy-transport-protocol",
"related": "http://example.org/api/rest/admin/gateways/25/term-proxy-transport-protocol"
},
"data": {
"type": "transport-protocols",
"id": "1"
}
},
"orig-proxy-transport-protocol": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/orig-proxy-transport-protocol",
"related": "http://example.org/api/rest/admin/gateways/25/orig-proxy-transport-protocol"
},
"data": {
"type": "transport-protocols",
"id": "1"
}
},
"rel100-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/rel100-mode",
"related": "http://example.org/api/rest/admin/gateways/25/rel100-mode"
},
"data": {
"type": "gateway-rel100-modes",
"id": "1"
}
},
"rx-inband-dtmf-filtering-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/rx-inband-dtmf-filtering-mode",
"related": "http://example.org/api/rest/admin/gateways/25/rx-inband-dtmf-filtering-mode"
},
"data": {
"type": "gateway-inband-dtmf-filtering-modes",
"id": "3"
}
},
"tx-inband-dtmf-filtering-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/tx-inband-dtmf-filtering-mode",
"related": "http://example.org/api/rest/admin/gateways/25/tx-inband-dtmf-filtering-mode"
},
"data": {
"type": "gateway-inband-dtmf-filtering-modes",
"id": "2"
}
},
"network-protocol-priority": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/network-protocol-priority",
"related": "http://example.org/api/rest/admin/gateways/25/network-protocol-priority"
},
"data": {
"type": "gateway-network-protocol-priorities",
"id": "3"
}
},
"media-encryption-mode": {
"links": {
"self": "http://example.org/api/rest/admin/gateways/25/relationships/media-encryption-mode",
"related": "http://example.org/api/rest/admin/gateways/25/media-encryption-mode"
},
"data": {
"type": "gateway-media-encryption-modes",
"id": "2"
}
}
}
}
}