POST /number-plan/number-conversion

Create number conversion in the system.

To create number conversion:

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

  2. Use POST /number-plan/number-conversion to send an HTTP POST request to the authentication service.

  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 - POST number-conversion
    {
  "typeOfConversion": "string",
  "numbersToConvert": 20,
  "typeOfNumBefore": "string",
  "digitsInsertAtBeginning": 20,
  "searchContinueIndication": "string",
  "routeNum": 3,
  "newTypeNumAfterConversion": "string",
  "targetDestNumber": 5,
  "bearerCapability": "string",
  "highLevelCompatibility": "string",
  "noOfDigitsToTruncate": 0
}
    The following table describes the request body parameters.
    Table 2. Parameters Description - POST number-conversion
    Parameter Name Sample Value Description
    >NumberConversionResponse
    >>typeOfConversion string Usage: Select the Conversion Type for the entered number.

    Options:

    • 0: Received B-number

    • 1: Sent A-number and sent connected number

    • 2: Received A-number and received connected number

    • 3: Bearer Capability and High-Level Compatibility substitution

    • 4: Inbound conversion

    • 5: Sent A-number and sent connected number to extension

    • 6: Received A-number for calls from remote extensions or Diverting number containing remote extension number

    • 7: A-number is converted to international number
    >>numbersToConvert string Usage: Enter the number that shall be converted.

    Format: 1 to 20 digits

    Options: 0-99999999999999999999

    When entering more than one number, separate the values with comma (,).

    Examples: 100 100,999999,300
    Note: This parameter is mandatory.
    >>typeOfNumBefore string Usage: Select which Type of Number the number is before the conversion.

    Options: Unknown public number International number National number Network specific number Local public number Unknown private number Local private number Level 1 regional number Internal directory number when sent to a public network Internal directory number when sent to a private network Internal directory number (used when search continues) None

    Notes: For Conversion Type Received B-number the allowed values are 0-7 and 12. For Conversion Type Sent A-number and sent connected number the allowed values are 0-7, 10,11 and None. For Conversion Type Received A-number and received connected number the allowed values are 0-7. For Conversion Type Inbound Conversion the allowed values are 0-7, 10-12 and None.
    >>digitsInsertAtBeginning string Usage: Enter the number of digits that shall be inserted in front of the number at the number conversion.

    Format: 1 to 10 digits for all Conversion Types except for "Sent A-number and sent connected number". "Sent A-number and sent connected number" accepts 20 digits.

    Options: 0-9999999999

    Example: 1 99999
    >>searchContinueIndication string Usage: Select whether the conversion shall continue.

    Options: Conversion shall not continue Conversion continues in the internal directory number table

    Notes: This field is enabled when Number Conversion Type is set to Received B-number.
    >>routeNum string Usage: Enter the number of the Route for which number conversion shall be done.

    Format: 1 to 3 digits

    Options: 1-250

    Example: 2
    >>newTypeNumAfterConversion string Usage: Select which type of number it should be after conversion.

    Options: Unknown public number National number International number Network specific number Local public number Unknown private number Local private number Level 1 regional number

    Note: This parameter is only valid when Sent A-number and sent connected number, Received A-number and sent connected number, or Received A-number for calls from remote extensions or Diverting number containing remote extension number has been selected in Conversion Type.
    >>targetDestNumber string Usage: Enter the number of the Target Destination for which number conversion shall be done.

    Format: 1 to 5 digits

    Options: 0 - 99999 Note:

    This parameter is only valid when Sent A-number and sent connected number has been selected in Conversion Type.
    >>bearerCapability string Usage: Select the Bearer Capability value that shall substitute the bearer capability received from the network.

    Options: None 1 = SPEECH 2 = 3.1-kHz Audio 3 = 64 kbps restricted 4 = 64 kbps unrestricted 5 = UDI-TA (7 kHz) 6 = 16 kbps unrestricted

    Notes: This field is enabled when Number Conversion Type is set to Bearer Capability and High Level Compatibility substitution.
    >>highLevelCompatibility string Usage: Select the High-Level Compatibility value that shall substitute the High-Level Compatibility received from the network.

    Options: None 0 = No teleservice 1 = Group 2/3 facsimile 2 = Teletex 3 = Videotex 4 = Group 4 facsimile 5 = Teletex 64 6 = Videotex 64 7 = Timelink 8 = 1/2 Video

    Notes: This field is enabled when Number Conversion Type is set to Bearer Capability and High Level Compability substitution.
    >>noOfDigitsToTruncate string -

  6. Click on Execute to generate the request URL.

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