Add an Inbound Route

Request URL

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

Request parameters


Parameter	Required	Type	Description
name	Yes	String	The name of an inbound route.
did	No	String	DID pattern.
caller_id	No	String	Caller ID pattern.
trunks	Yes	String	Trunk name. Separate multiple trunk names with `,`. Example: `"trunks":"trunk1,trunk2"`
desttype	Yes	String	Destination type. Valid values: hangup extension extrange voicemail ivr ringgroup queue conference disa callback outroute faxtoemail
dest	Yes	String	The specific destination.

Response parameters


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

Examples

Request example

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

{
	"name": "trunk1",
	"did": "5503301",
	"caller_id": "3000",
	"trunks": "sipTrunk",
	"desttype": "hangup"
}

Response example

After the inbound route is added successfully, the system will automatically assign an id to the inbound 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"
}