POST /pm-extension-ms/pm-extension/v1/ip

Create IP extension into provisioning manager and respective subsystem.

To create IP extension:

  1. Perform the authentication and login to the API. For more information, see POST /auth/login.

  2. Use POST /pm-extension-ms/pm-extension/v1/ip to send an HTTP POST request.

  3. Click Try it Out option.

  4. Set the parameters as listed in the following table.

    Parameter Name

    Sample Value

    Supported Value

    Description

    subsystemName

    subsystemName

    string
    Indicates the subsystem name (MiVoice MX-ONE).
    Note:

    This parameter is mandatory.

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

  6. Enter the request body parameter values as follows:
    Note: The highlighted parameters are mandatory and it must be configured in the request body.
    {
  "extensionNumber": "string",
  "featureLevel": "string",
  "customer": "string",
  "description": "string",
  "domainName": "string",
  "serverNumber": 0,
  "commonServiceProfile": 0,
  "phoneLanguage": "default",
  "bossSecretary": false,
  "homeAreaCode": "string",
  "macAddress": "string",
  "allowThirdPartyClient": false,
  "backupAnsweringPositionNumber": "string",
  "allowSecurityException": true,
  "maximumChargingCost": "string",
  "ipExtensionType": "IPManualLogin",
  "freeOnSecondLine": 0,
  "allowExtensioninCallParkPoolGroup": true,
  "automaticSIPRegistration": {
    "terminalIdentity": "string",
    "singleLineAccess": true,
    "universalResourceIdentifier": "string",
    "portNumber": "string",
    "transport": "string",
    "translatedBnumberPrefix": "string"
  },
  "sipRemoteExtension": {
    "terminalIdentity": "string",
    "trunkType": "Route",
    "sipRouteNumber": 0,
    "sipBackupRoutenumber": 0,
    "destinationNumber": "string",
    "defaultRemoteNumber": "string",
    "receivedANumber": "string",
    "singleLineAccess": true
  },
  "nameIdentity": {
    "firstName": "string",
    "lastName": "string",
    "includeinDialbyNameDatabase": true,
    "namePresentationOrder": "string",
    "restrictPresentation": true,
    "information": "string"
  },
  "welcomeAnnouncement": "string",
  "continuousAnnouncement": "string",
  "authorizationCodes": [
    {
      "authorizationCode": "string",
      "hashType": "string",
      "callLoggingCode": "string",
      "customer": "string",
      "newCustomer": "string",
      "commonServiceProfile": "string",
      "restrictUsageToThisExtensionOnly": true
    }
  ],
  "ringSignals": [
    {
      "callingNumber": "string",
      "routeNumber": "string",
      "ringType": "string",
      "customer": "string"
    }
  ],
  "publicCLINumber": {
    "publicCLINumber": "string",
    "activateCLInumber": "string",
    "typeOfCLInumber": "string",
    "publicCLINumberPresentationRestriction": true
  },
  "parallelRinging": {
    "mdir": "string",
    "secondaryDirectoryNumber1": "string",
    "secondaryDirectoryNumber2": "string",
    "delaySeizure": "string"
  },
  "phoneType": "R",
  "hotlineNumber": "string",
  "aliasNumberToUse": "string",
  "individualAliasNumber": "string",
  "huntGroup": {
    "huntGroupNumber": "string",
    "groupAlias": true
  },
  "callPickupGroup": "string",
  "groupDoNotDisturb": "string"
}
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description

    >extensionNumber

    String
    Extension Number.
    Note: This parameter is mandatory.

    >featureLevel

    String

    -

    >customer

    String

    -

    >description

    String

    Enter a short description for the Extension. Description field is not visible for templates.

    Format: Up to 255 alphanumerical characters.

    >domainName

    String

    Select a domain for the extension. By associating an extension to a domain instead of a server, the extension is initiated on the most suitable server within the domain (regarding for example free capacity).

    Selecting a domain overrides the Server Number selection for the extension.

    >serverNumber

    Integer (int32)

    Select a telephony server on which the extension will be initiated.

    If a domain is selected in the Domain Name field, the server selection is overridden.

    >commonServiceProfile

    Integer (int32)

    Common Service Profile number.

    Common service profiles define privileges and settings for IP, mobile, DECT, and virtual extensions.

    Options:

    A list of available Common Service Profiles in the MiVoice MX-ONE. The customer group associated with the CSP is presented in parentheses.
    Note: This parameter is mandatory.

    >phoneLanguage

    default
    Select the Language for the extension. Text messages will appear in the display on the phone in this language.
    Note: This parameter is mandatory.

    >bossSecretary

    false

    Using the Boss-Secretary function, calls to an IP or digital phone (the boss's extension) can be directly diverted to up to ten extensions (the secretaries extensions). The personal number list #1, with the number of the secretary, must be initiated for the phone of the boss. A PEN key must be initiated on the secretary's and also on the boss' phone. With the PEN key the boss / secretary feature can be activated / deactivated for the boss.

    The function key LED indicates the status of the function (on IP and digital phones only). Only calls from the secretary can override the diversion of the boss's phone when the function is on.

    Steps to set up the Boss/Secretary feature on an IP phone:

    • Create an extension for the boss.

    • Create an extension for the secretary and set the Boss/Secretary setting to Secretary.

    • Define the personal number list number 1 on the boss' extension including the secretary's number and enable the check box for.

    • Individual Repeated Distribution Bypass.

    • Define a PEN function key on the secretary's extension and enter the boss' extension number as the monitored number.

    • Define a PEN function key on the boss' extension and either leave the monitored number blank or enter the own number.
       
    Steps to set up the Boss/Secretary feature on a digital phone:

    • Create an extension for the boss and set the Boss/Secretary setting to Boss.

    • Create an extension for the secretary and set the Boss/Secretary setting to Secretary.

    • Define a BSEC-Secretary function key on the secretary's extension and enter the boss' extension number as the monitored number.

    • Define a BSEC-Boss function key on the boss' extension and enter the secretary's number and the additional info requested.

    • A personal number list will automatically be created including the secretary's number.

    Options:

    • Boss (not for IP extensions)

    • Secretary

    >homeAreaCode

    String

    Enter the Home Area Code for the extension.

    Home Area Code will be associated to the Generic User(ISP). Associating a fixed home area code to the generic user will ensure that the DID number for a call from such a user, will always use the correct code, and therefore result in the correct DID number, irrespective of the domain or LIM to which, the user has logged on to.

    Format: 1 to 6 digits.

    Options: 0-999999

    >macAddress

    String

    States the MAC address of a device.

    Format: 0123456789AB, 01:23:45:67:89:AB, or 01-23-45-67-89-AB

    >allowThirdPartyClient

    false

    States whether a third party client is permitted to be used.
    >backupAnsweringPositionNumber

    String

    Enter the Backup Answering Position Number.

    A backup answering position number must be provided for IP extensions located at the branch office. These back up positions must be public network numbers.

    IP extensions at the branch office must be configured to periodically re-register to the MiVoice MX-ONE. If an IP extension fails to re-register on time, the MiVoice MX-ONE will consider it to be marooned and will redirect incoming calls to its back up answering position.

    Format: 2 to 20 digits.

    >allowSecurityException

    Boolean

    Select if to Allow Security Exception, that is, if the extension is allowed in the system without signaling or media encryption.

    If an extension number that is not allowed to have a security exception tries to log in insecurely the registration will be rejected.

    >maximumChargingCost

    String

    Enter Maximum Charging Cost.

    The entered value states the maximum charging cost in pulses assigned for the extension. When no value is entered, the extension has no limitation on the duration of the call. When a value is entered, the call will be disconnected when the entered number of pulses has been used.

    >ipExtensionType

    IPManualLogin

    Choose the IP Extension Type for your telephone.

    Options:

    • IP Manually Logged In (IPManualLogin): Normal IP telephone.

    • Automatic SIP Registration (SIPAutoRegn): Permanently registered SIP telephone.

    • SIP Remote Extension (SIPRemote): Remote extension, typically a cellphone.

    Default is IP Manually Logged In.

    >freeOnSecondLine

    0

    Select the options for Free On Second Line dropdown list. Category setting for free-on-second line functionality. This function is only supported by Mitel SIP extensions.

    Options:

    • 0: Yes, but can be changed via terminal menu.

    • 1: No, but can be changed via terminal menu.

    • 2: Yes, can not be changed via terminal menu.

    • 3: No, can not be changed via terminal menu.
    >allowExtensioninCallParkPoolGroup

    Boolean

    Select if to Allow Extension in call park pool group, that is, the extension can be a part of call park pool group.

    >automaticSIPRegistration

    >>terminalIdentity

    Sting

    Enter the host part of the terminal identity, which is the contact address of the terminal (or the communication server) representing the directory number

    The terminal identity string consists of the directory number and the domain name (host) of the communication server, but it is only the domain name that needs to be entered here.

    Format: Up to 100 alphanumeric characters.

    Note:
    In the background,

    • the system concatenates the entered terminal identity to the directory number so the complete string will look like this ExtensionNumber@host.

      For example, [email protected].

    • For SIP Remote extensions (or Mobile extensions that are configured to use SIP routes), if the field is left blank, the current host name is used, otherwise, the entered value for terminal identity is used, and the complete terminal identity string is displayed.

      For example, sip:[email protected].

    Note: For expert users: This field accepts any string and no other validation is necessary. The terminal identity string is a unique logical handle for IP extensions which can use any form, although it is more commonly entered as an IP address or domain name. This field is generally used for trace purposes.

    >>singleLineAccess

    Boolean

    Select if remote end shall be treated as a multi line access terminal.
    >>universalResourceIdentifier

    Sting

    >>portNumber

    Sting

    >>transport

    Sting

    >>translatedBnumber

    Prefix

    Sting

    >sipRemoteExtension

    >>terminalIdentity

    Sting

    Enter the host part of the terminal identity, which is the contact address of the terminal (or the communication server) representing the directory number

    The terminal identity string consists of the directory number and the domain name (host) of the communication server, but it is only the domain name that needs to be entered here.

    Format: Up to 100 alphanumeric characters.

    Note:
    In the background,

    • the system concatenates the entered terminal identity to the directory number so the complete string will look like this ExtensionNumber@host.

      For example, [email protected].

    • For SIP Remote extensions (or Mobile extensions that are configured to use SIP routes), if the field is left blank, the current host name is used, otherwise, the entered value for terminal identity is used, and the complete terminal identity string is displayed.

      For example, sip:[email protected].

    Note: For expert users: This field accepts any string and no other validation is necessary. The terminal identity string is a unique logical handle for IP extensions which can use any form, although it is more commonly entered as an IP address or domain name. This field is generally used for trace purposes.

    >>trunkType

    Route

    Select which Trunk Route or Destination to use.

    Options:

    • Route: If you want the sip remote extension initiated with a route then select route

    • Destination: If you want the sip remote extension initiated with a Destination then select Destination.

    Default is Route.
    Note: The default one is Route, if the destinations are not available, then the GUI will not display the Destination field in the GUI .To get destinations please initiate them in Service node manager.

    >>sipRouteNumber

    Integer (int32)

    SIP Route Number.
    >>sipBackupRoutenumber

    Integer (int32)

    Select SIP Backup route number.

    >>destinationNumber

    String

    Select destination number.

    >>defaultRemoteNumber

    String

    Enter the Default Remote Number for the extension.

    >>receivedANumber

    String

    Enter the Received A Number(s).

    >>singleLineAccess

    Boolean

    Select if remote end shall be treated as a multi line access terminal.

    >nameIdentity

    >>firstName

    String

    >>lastName

    String

    >>includeinDialbyNameDatabase

    Boolean

    >>namePresentationOrder

    String

    >>restrictPresentation

    Boolean

    >>information

    String

    >welcomeAnnouncement

    String

    Select which voice message to use as Welcome Announcement.
    >continuousAnnouncement

    String

    Select which voice message to use for playing/replaying a periodic message for calls put on hold by the extension.

    >authorizationCodes

    >>authorizationCode

    String

    >>hashType

    String

    >>callLoggingCode

    String

    >>customer

    String

    >>newCustomer

    String

    >>commonServiceProfile

    String

    >>restrictUsageToThisExtensionOnly

    Boolean

    >ringSignals

    >>callingNumber

    String

    >>routeNumber

    String

    >>ringType

    String

    >>customer

    String

    >publicCLINumber

    >>publicCLINumber

    String

    >>activateCLInumber

    String

    >>typeOfCLInumber

    String

    >>publicCLINumberPresentationRestriction

    Boolean

    >parallelRinging

    >>mdir

    String

    >>secondaryDirectoryNumber1

    String

    >>secondaryDirectoryNumber2

    String

    >>delaySeizure

    String

    >phoneType

    R

    Select the Phone Type, that is, if the extension shall have an extra function.

    Special purpose extensions are extensions with extra functions.

    Format:

    • R: Normal: no extra functions are defined for the extension.

    • N: Hot-line: when the user lifts the handset a call is made immediately to the direct connection number defined in Hotline Number.

    • D: Delayed hot-line: makes it possible to have the phone initiated as a hot-line and still be able to use it as a normal phone.

    >hotlineNumber

    String

    Enter the Hotline Number, that is, the direct connection number for the hotline.

    The direct connection number can be a directory number, a PBX operator number, an external number, a common abbreviated number, or a procedure. Format: 1 to 26 characters

    >aliasNumberToUse

    String

    Choose the Alias Number Type for your telephone.

    The configured Alias Number is shown to the other connected extensions during call.

    Options:

    • No Alias Number: No Alias Number is needed for the telephone.

    • Individual Alias: This requires a CTI group number. The CTI group number must be already configured as Alias Number from Service Node Manager.

    • Group Alias: Alias Number requires a Hunt Group number that the extension is a member of.

    >individualAliasNumber

    String

    Provide the CTI Group number as Individual Alias Number.

    >huntGroup

    >>huntGroupNumber

    String

    >>groupAlias

    Boolean

    >callPickupGroup

    String

    Select the number of the Call Pickup Group that the extension shall be a member of.

    A call pickup group consists of a number of extensions that have been assigned a common sequence number (group number). A member of a group can pick up calls to other members in the same group by using a dialing procedure. Options:

    List of available call pickup groups in the MiVoice MX-ONE.

    >groupDoNotDisturb

    String

    Select the Do Not Disturb Group that the extension shall be a member of.

    The possible operations are the following:

    • Add Do Not Disturb group membership for all Extension types.

    • Add an extension as a member of Do Not Disturb group while initiating an extension

    • Add/modify/remove the Do Not Disturb group membership details while changing an extension data

    • Remove an extension that is part of a Do Not Disturb group

  7. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/pm-extension-ms/pm-extension/v1/ip?subsystemName=1
    The following table lists the expected responses.

    Response Type

    Value

    Schema
    Valid Response

    200 OK

    See 200 OK: POST /pm-extension-ms/pm-extension/v1/ip
    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: Extension
↑