Config API Version 2 Dialplans

Introduction

Dialplans are part of the Phone System Manager.

They control the flow of inbound calls and allow you to edit features in the dialplan such as destination endpoints, IVRs, time routing etc.

List Destination Endpoint Maps

Destination Endpoint Maps provide the ability to create multiple named endpoints that can be be used in dialplans to route to certain destinations, but can be edited without editing the dialplan itself.

This route lists the destination endpoint maps available in an IGRP.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps

URL Path Params

IGRP SPECIFIER (int) - Installation ID.

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

Filter Types

mapId (int) - Map ID
mapName (string) - Map Name
updateDatetime (datetime) - Last Updated Datetime

Sort Types

Same fields as Filter Types, see above.

Response:

HTTP 200 - OK

Read Destination Endpoint Map

This route gets the configuration for a single destination endpoint map.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps/{DEST MAP SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
DEST MAP SPECIFIER (int) - Destination Map ID.

Response:

HTTP 200 - OK

List Destination Endpoint Map Items

Destination Endpoint Maps can contain multiple destinations. Each map item is assigned to a named key that is then referenced from other points in the dialplan.

This route lists the destination map items in a destination endpoint map.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps/{DEST MAP SPECIFIER}/items

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
DEST MAP SPECIFIER (int) - Destination Map ID.

GET Params

filter (array) OPTIONAL - One or more filters.
sort (array) OPTIONAL - One or more sorting params.
limit (integer) OPTIONAL - limit on the result set.
offset (integer) OPTIONAL - offset of the result set.

Filter Types

mapItemId (int) - Map Item ID
mapId (int) - Map ID
itemKey (string) - Item Key
itemValue (string) - Item Value
updateDatetime (datetime) - Last Updated Datetime

Sort Types

Same fields as Filter Types, see above.

Response:

HTTP 200 - OK

Read Destination Endpoint Map Item

This route gets the configuration for a single destination endpoint map.

Request:

GET /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps/{DEST MAP SPECIFIER}/items/{DEST MAP ITEM SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
DEST MAP SPECIFIER (int) - Destination Map ID.
DEST MAP ITEM SPECIFIER (int) - Destination Map Item ID.

Response:

HTTP 200 - OK

Add Destination Endpoint Map Item

This route allows you to add an item to a destination map.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps/{DEST MAP SPECIFIER}/items

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
DEST MAP SPECIFIER (int) - Destination Map ID.

POST Params

itemKey (string) - Item Key
itemValue (string) - Item Value

Response:

HTTP 201 - CREATED

Update Destination Endpoint Map Item

This route allows you to add an item to a destination map.

Request:

POST /config/v2/igrps/{IGRP SPECIFIER}/dialplans/destinationMaps/{DEST MAP SPECIFIER}/items/{DEST MAP ITEM SPECIFIER}

URL Path Params

IGRP SPECIFIER (int) - Installation ID.
DEST MAP SPECIFIER (int) - Destination Map ID.
DEST MAP ITEM SPECIFIER (int) - Destination Map Item ID.

POST Params

itemKey (string) OPTIONAL - Item Key
itemValue (string) OPTIONAL - Item Value

Response:

HTTP 204 - NO CONTENT