DELETE /number-plan/number-series

Delete number series.

To delete number series:

  1. Perform the authentication and login to the API. For more information, see Authentication.

  2. Use DELETE /number-plan/number-series to send an HTTP DELETE request.

  3. Click Try it Out option.

  4. Under Request body select application/json from drop-down list.

  5. Enter the request body parameter values as follows:

    Table 1. Parameters Hierarchy - DELETE number-series 
    {
  "directoryNumbers": "",
  "commonOperatorNumbers": "",
  "individualOperatorNumbers": "",
  "commonAbbreviatedNumbers": "",
  "emergencyNumbersOperator": "",
  "individualAbbreviatedNumbers": "",
  "routeDirNumbers": "",
  "dialedNumberInfoSvc": "",
  "pagingNumbers": "",
  "gatewayRoutingNumbers": "",
  "leastCostRouting": "",
  "commonDirectDialingNum": "",
  "ownNodeNumber": "",
  "commonPublicDirNum": "",
  "accessNumWithoutAuth": "",
  "accessNumWithAuth": "",
  "accessNumWithoutAuthWithoutDialtone": "",
  "publicDestCostRouting": "",
  "directInwardSvcAccess": "",
  "extCoordDestination": "string",
  "extDestination": "string",
  "fictitiousDestNum": "string"
}
    The following table describes the request body parameters.
    Table 2. Parameters Description - DELETE number-series

    Parameter Name

    Sample Value

    Description
    >NumberSeriesResponse
    >>directoryNumbers string Usage: Enter an directory number or directory numbers. directory numbers include numbers of extension, including directory number of group hunting group.

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207

    Note: This parameter is mandatory.
    >>commonOperatorNumbers string Usage: Enter common operator number or numbers.

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101, 201

      Example: 101,201,205-207
    >>individualOperatorNumbers string Usage: Enter individual operator number or numbers.

    Format: Numerical value, 1 to 20 digits

    Options: Available extensions in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>commonAbbreviatedNumbers string Usage: Enter common abbreviated number or numbers.

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>emergencyNumbersOperator string Usage: Enter the emergency numbers to operator.

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>individualAbbreviatedNumbers string Usage: Enter an individual abbreviated number or numbers.

    Format: Numerical value, 1 digit

    Options: Available numbers in the range 0-9

    The numbers can be entered as the following:

    • Single number

      Example: 1

    • Multiple numbers

      Example: 1,3
    >>routeDirNumbers string Usage: Enter the route directory number or numbers to use for all incoming calls on an incoming route. The number is included in the numbering plan for the exchange. The route directory number is used when the incoming route cannot transfer a public and/or private calling number and the calling number is requested, for example at transit traffic when the subsequent exchange requests calling party number transfer. At outgoing transit or gateway traffic the complete calling number is composed using the route directory number and the exchange number (public or private).

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>dialedNumberInfoSvc string Usage: Enter a Dialed Number Information Service (DNIS) number or numbers. The DNIS number makes it possible to identify different customers based on the number the customer is dialing. When the call is presented the DNIS number and name are displayed together with the calling party number and name.

    Format: 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999.

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>pagingNumbers string Usage: Enter a Paging number or numbers. Paging is used to send one-way messages to persons with either a pager or with a personal code over an acoustical/optical system. It enables persons to be paged from an extension, an operator or external line.

    Format: 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>gatewayRoutingNumbers string Usage: Enter a Gateway Routing number or numbers. The ability to route media for VoIP calls, within one PBX, via the public ISDN, as an alternative to RTP via TCP/IP (or to Group Switch) connection. It can also be used as fallback when encountering Call Admission Control congestion for the IP connection between media gateways and LIMs in the same PBX system.

    Format: 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207

    Note: The gateway routing numbers can be initiated only after loading a IGWP unit. It can be done by initiating the command pu_add at MX-ONE. Example: pu_add -unit IGWP.
    >>leastCostRouting string Usage: Enter the least cost routing access code or codes, used to find the most economical route for an outgoing public call.

    Format: Numerical value, 1 to 10 digits

    Options: Available numbers in the range 0-9999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>commonDirectDialingNum string Usage: Enter the common direct in-dialing operator number or numbers (also called common operator number for direct in-dialing).

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>ownNodeNumber string Usage: Enter the own node (PBX) number within the private network

    Format: Numerical value, 1 to 5 digits

    Options: Available numbers in the range 0-99999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>commonPublicDirNum string Usage: Enter a common public directory number or numbers.

    Format: Numerical value, 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers

      Example: 101,201
    >>accessNumWithoutAuth string Usage: Enter an access number or numbers for mobile extension (without authorization), that is, access number(s) for a remote extension when the calling party number is not received in the exchange.

    Format: 1 to 20 digits

    Options: Available number in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>accessNumWithAuth string Usage: Enter an access number or numbers for mobile extension (with authorization), that is, access number(s) for a remote extension when the calling party number is received in the exchange.

    Format: 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>accessNumWithoutAuthWithoutDialtone string Usage: Enter an access number or numbers for mobile extension (without authorization and DialTone), that is, access number(s) for a remote extension when the calling party number is not received in the exchange.

    Format: 1 to 20 digits

    Options: Available number in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>publicDestCostRouting string Usage: Enter the public destination least cost routing numbers, that is, the public destination access code. The public destination access code, which is mainly used in the US as a complement to the Least Cost Routing Access Code. When using a public destination access code, the call is not least cost routed, but external numbers may be (selectively) barred for calls by using the least cost routing features, toll restriction and forced account code.

    Format: Numerical value, 1 to 10 digits

    Options: Available numbers in the range 0-9999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>directInwardSvcAccess string Usage: Enter a Direct Inward System Access (DISA) number or numbers. Direct Inward System Access is a facility allowing external users (voice calls) to call in to a PBX and get access to a limited set of the PBX's features. The primary application is the ability for users to charge expensive long distance calls to the PBX. A DISA call can be established by the use of Direct In-dialing external lines or manual external lines. These lines have to be connected to a DTMF code receiver to provide end-to-end signaling.

    Format: 1 to 20 digits

    Options: Available numbers in the range 0-99999999999999999999

    The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers, including ranges

      Example: 101,201

      Example: 101,201,205-207
    >>extCoordDestination integer($int32) -
    >>extDestination integer($int32) -
    >>fictitiousDestNum integer($int32) -

  6. Click on Execute to generate the request URL.

    Request URL:
    http://<IP_Address>:<PORT>/extension-ms/number-plan/number-series
    See Appendix A: Response Codes for expected responses.
Parent topic: Number Plan
↑