Setting Up API Dialplan

The API Dialplan offers custom solutions for the clients to implement various other features which are not possible through the standard version or from the user interface. It is based on request, response, and action to be performed.

API Dialplan acts upon the user's API and provides a response in return describing the series of actions to be performed.

The portal allows you to create and view API Dialpan.

To create an API Dialplan, follow these steps:

  1. Log into Smartflo portal.
    Image1

  2. Click on Services and select API Dialplan.
    Image2

  3. A list of all the API dial plans appears along with the relevant details. Click Add API Dialplan to add a new one.
    Image3

  4. Enter Name, Description, URL, Failover Destination, Request Method, and Ring Timeout. Then, click Save.
    Image4

FieldDescription
NameEnter the name of API dialplan.
DescriptionEnter the description of API dialplan.
URLEnter the URL of the customer's API.
Failover DestinationSelect the destination where the call should be routed upon failure.
Request MethodRequest type for the API Get or Post.
Content-TypeSelect the content type to get data in URL or JSON format.
Ring TimeoutEnter the time (in seconds) for which the call will ring.
  1. Upon successful creation of API Dialplan, you will get an acknowledgment message for the same. Click on Select an Action to perform an edit/delete operation on the API Dialplan.
    Image5

  2. Click My Numbers to assign API Dialplan to a DID.
    Image6

  3. Click Select an Action and then click Edit.
    Image7

  4. Select Destination as your API Dialplan and click SAVE.
    Image8

You will get a confirmation message as Number Updated stating that you have successfully assigned DID to your API Dialplan.
Image9

Click here to know more in-depth about API Dialplan.