Help & Support

Dial Plans

The service methods available for Dial Plan records are listed below. In all cases the "where" parameter is an optional filter. It can be used to filter the results of a Get or Count query. Note that the Add and Update methods are can only be used for Ruby dial plans and not either of the wizard dial plan types.

  • Count: GET dialplan/count?where={where},
  • Get: GET dialplan/get?where={where}&offset={offset}&count={count}
  • Add: POST dialplan/add where the request body is a JSON formatted Dial Plan
  • Update: POST dialplan/update where the request body is a JSON formatted Dial Plan
  • Delete: GET dialplan/delete?id={id}
  • Copy: GET dialplan/copy?id={id}

The typical JSON format for a Dial Plan is shown below. When updating a Dial Plan all the properties must be specified and any properties that are ommitted will be set to their default value which will be null in most cases.

A description for each of the Dial Plan properties is listed below.

  • ID: A system generated GUID that uniquely identifies the Dial Plan record. It cannot be updated.
  • DialPlanName: A descriptive name for the Dial Plan record. The Dial Plan name is used when selecting the outgoing and incoming dial plans that a SIP account uses.
  • TraceEmailAddress: An optional parameter that if set will email a trace of the log messages from each (and every) execution of the dial plan.
  • DialPlanScript: The Ruby script for the dial plan.
  • ScriptTypeDescription: The type of the dial plan. It cannot be updated and in most cases should be set to "Ruby".
  • AcceptNonInvite: A boolean parameter that if set to true allows the dial plan to process other requests apart from INVITEs. In most cases should be left as False.

The Ruby script below illustrates how to use each of the service methods for Dial Plan records.