Add an Outbound Route

Request URL

{base_url}/{api_path}/outroute/add?token={token}

Request parameters


Parameter	Required	Type	Description
name	Yes	String	The name of an outbound route.
prefix	Yes	String	Dial pattern.
strip	No	String	How many digits will be stripped from the front of the dialed number before the call is placed.
prepend	No	String	The prepended number will be added to the beginning of a dialed number.
trunks	Yes	String	Trunk name. Separate multiple trunk names with `,`. Example: `"trunks":"trunk1,trunk2"`
extensions	Yes	String	Extensions which are allowed to make outbound calls through this route. Separate multiple extensions with `,`. Example: `"extensions":"1001,1002"`
extensionsgroup	No	String	Extension groups which are allowed to make outbound calls through this route. Separate multiple extension groups with `,`. Example: `"extensionsgroup":"sales,support"`

Response parameters


Parameter	Type	Description
id	Integer	The unique ID of an outbound route.
status	String	Request result. Success Failed

Examples

Request example

POST /api/v2.0.0/outroute/add?token=277ac400357b509b4a587ff2157f7ad5
Content-Type:application/json; charset=utf-8
Host: 192.168.5.150

{
    "name": "outroute1",
    "prefix": "0",
    "strip": "1",
    "trunks": "siptrunk",
    "extensions": "1001",
    "extensionsgroup": "sales,support"
}

Response example

After the outbound route is added successfully, the system will automatically assign an id to the outbound route.

HTTP/1.1 200 OK
Server: Boa/0.94.14rc21
Accept-Ranges: bytes
Connection: close
Content-Type: application/json
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{
	"id": "8",
	"status": "Success"
}