Download OpenAPI specification:Download
Gateways
Adds one or more SIP gateways to the account. Each gateway must resolve to a routable public IPv4 address. Optional port specified as host:port.
Body for add gateways.
| apikey required | string |
required | Array of objects |
{- "apikey": "Your API Key",
- "gateways": [ ]
}{- "message": "Gateways Entered",
- "status": "Success",
- "gateways": [ ],
- "statusCode": "200"
}Returns all system route types and user-defined SIP gateways for the account. System routes (IDs 1-8) are always included: 1=USER, 2=T30, 3=VOICE_BRIDGE, 4=DID, 5=T38, 6=RTC_BRIDGE, 8=SDN.
Body for list gateways.
| apikey required | string |
{- "apikey": "Your API Key"
}{- "status": "Success",
- "gateways": [ ],
- "statusCode": "200"
}Removes one or more gateways by route ID. A gateway cannot be removed if DIDs are currently routed to it.
Body for remove gateways.
| apikey required | string |
required | Array of objects |
{- "apikey": "Your API Key",
- "routes": [ ]
}{- "message": "Gateways Removed",
- "status": "Success",
- "routes": [ ],
- "statusCode": "200"
}Updates the IP or hostname of one or more existing gateways by route ID.
Body for update gateways.
| apikey required | string |
required | Array of objects |
{- "apikey": "Your API Key",
- "gateways": [ ]
}{- "message": "Gateway updated",
- "status": "Success",
- "gateways": [ ],
- "statusCode": "200"
}