POST /tenant/tenant-configuration/v1

This method is used to add a new tenant customer.

To add the tenant Configuration:

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

  2. Use POST /tenant/tenant-configuration/v1 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:
    {
 "mxoneSubsystem": "string", "customerNumber": 0, "customerName": "string",   "acronym": "string",
 "domainName": "string",   "domainOwner": true,
  "restrictTerminalRegistrationFromForeignIPDomains": true,
  "enableShortUserIdFormat": true,
  "exceptionForDialingNumbers": "string",
  "allowDirectCallsBetweenCustomers": true,
  "financeId": "string",
  "directoryNumbers": [
    {
      "directoryNumbers": "string",
      "prefixLength": 0,
      "extraDigits": "string"
    }
  ],
  "commonAbbreviatedNumbers": [
    {
      "commonAbbreviatedNumbers": "string",
      "prefixLength": 0,
      "extraDigits": "string"
    }
  ],
  "subscribers": [
    {
      "numberRange": 0,
      "featurelevel": "string",
      "dialingPrivileges": "Internal",
      "endUserDeviceType": "Mitel 6863i"
    }
  ]
}
    The following table describes the request body parameters.

    Parameter Name

    Sample Value

    Description

    >mxoneSubsystem

    String

    Enter the Telephony System.

    Options: Available Telephony Subsystems that have been previously created.
    Note: This parameter is mandatory.

    >customerNumber

    integer($int32)

    Enter a customer number.Customer Number is matching the "Customer number" in SNM Customer task.

    Format: Numerical value, 1 to 5 digits

    Options: Available numbers in the range 1-50000. The numbers can be entered as the single number.

    Example: 100
    Note: This parameter is mandatory.

    >customerName

    String

    Enter the customer name.

    Format: Up to 40 alphanumeric characters.

    Options: If Customer Name is not entered then Customer Number will be its default value.

    Example: Mitel or 2520

    Maximum Length: 40

    Minimum Length: 0

    Pattern: ^[^ ,"\\&<>?*]([^,"\\&><?*])*$
    Note: This parameter is mandatory.

    >acronym

    String

    Enter the acronym.

    Options:

    • Acronym/name should be maximum of 10 characters.

    • It must not start or end with a number.

    • The name is used on SIP extensions idle display.

    • The name is inserted before the internal part of a number if the SIP extension is registered with a short number within a range.

    Example: AAS@#R or Universal_tires

    Maximum Length: 20

    Minimum Length: 0

    Pattern: ^[^ ,"\\&<>?*]([^,"\\&><?*])*$

    >domainName

    String

    Enter a domain for the customer. The domain is used for log on and registering purposes for SIP extensions. If the IP address of the registering part can be name matched with a domain under command "ip_domain" the user may log on using the short internal number within the range.

    Options: Available telephony domains, as defined in the Telephony Domain task in Service Node Manager (Telephony>IP Phone).
    Note: This parameter is mandatory.

    >domainOwner

    Boolean

    Enter this true if the registering terminals cannot register to a group outside this domain. To be a domain owner means registering terminals can not register to a customer group outside the domain the terminal is in regardless if the target customer group permits this or not. Permitted values are yes or no, default is no.

    Format: true/false

    Options:

    • true: If true, the registering terminals cannot register to a group outside this domain.

    • false: If false,the registering terminals can register to a group outside this domain, if target group permits.
    >restrictTerminalRegistrationFromForeignIPDomains

    Boolean

    Select this true, if the customer group does not allow registration of IP extensions from foreign domains. This parameter decides whether the group allows registration from other than own IP domains. If this parameter is set to yes, registration of IP extension is only allowed if the registered IP address is within a domain belonging to this group.

    Permitted values are yes or no, default is no.

    Format: true/false

    Options:

    • true: If selected, registration of IP extension is only allowed if the registered IP address is within a domain belonging to this group.

    • false: If cleared, registration of IP extension is allowed even if the registered IP address is from other domains.
    >enableShortUserIdFormat

    Boolean

    Select this true if the SIP terminals shall use short user ID format. This parameter forces SIP terminals that are logging on, to use short user ID format regardless of the user ID format used otherwise in the system.

    Permitted values are yes and no. Default is no.

    Format: true/false

    Options:

    • true: If selected, SIP terminals shall use short user ID format.

    • false: If cleared, SIP terminals need not use short user ID format.
    >exceptionForDialingNumbers

    String

    Enter dialing numbers.Exception for dialing numbers are numbers that will be excluded from the customer restriction. These numbers will be common for ALL customer groups.

    Format: Numerical value, 1 to 10 digits

    Options: Exception for dialing numbers should accept comma separated numbers and maximum of 10 digit in length for each number. The numbers can be entered as the following:

    • Single number

      Example: 101

    • Multiple numbers

      Example: 101,201

      Example: 101,201,100000000

    Pattern: ^((\s*)[0-9]{1,20}[*])$|^(\s*(([0-9]{1,20}(\s*),(\s*))|([0-9]{1,20}(\s*)-(\s*)[0-9]{1,20}(\s*),(\s*)))*([0-9]{1,20}|([0-9]{1,20}(\s*)-(\s*)[0-9]{1,20}))\s*)$|^((\s*)([Aa][Ll][Ll]|[Aa][Ll][Ll][Ee])(\s*))$|^([*])$|^((\s*)[&gt;](\s*)[0-9]{1,20}(\s*))$
    >allowDirectCallsBetweenCustomers

    Boolean

    Select this true if the customer group wants to use Open dialing scheme. This parameter decides whether the group uses open or closed dialing scheme. If the scheme is open it is allowed to dial numbers which can not be range checked. If the scheme is closed,then numbers that can not be range checked will be barred from dialing. If the customer groups are belonging to a single company and want connectivity between them, the scheme open is preferred. If the customer groups are belonging to different companies and do not want connectivity between them, the closed scheme is preferred. Note that mixing open and closed schemes in the same may yield undesired results, such as that open groups may dial closed groups.

    Permitted values are yes or no, default is no.

    Format: true/false

    Options:

    • true: If true, scheme is open dialing and it is allowed to dial numbers which can not be range checked.

    • Cleared: If cleared, scheme is closed dialing,then numbers that can not be range checked will be barred from dialing.

    >financeId

    String

    Finance ID is presented in the customer report, as part of the license usage reports. This information can be used for charging purposes in multi-customer/tenant systems.

    Format: Alphanumerical characters, including white space

    Pattern: ^[^ '",\\&<>?*=+;/]([^'",\\&<>?*=+;/])*$

    >directoryNumbers

    String

    Enter directory number or directory numbers for a customer group.

    Format: Numerical value, 2 to 20 digits Options: Available numbers in the range 00-99999999999999999999 The numbers can be entered as the following:

    • Single number

      Example: 101

    • Ranges

      Example: 205-207

    • Directory Numbers. It consists of two parts:

      • Prefix Length. (tenant prefix)

      • Extra Digits. (extension number/Extra Digits)

    Note: This parameter is mandatory.

    >>prefixLength

    integer($int32)

    Enter the depth or prefix length. The Prefix Length is the number of digits that needs to be removed from the tenant prefix of the Directory numbers. Prefix depth/length defines the boundary between prefix and internal (short) number within a range.

    Options:

    • Available Prefix Length which is derived based on the entered directory Number.

    • The prefix length will be the length of the common numbers of the start and stop number range.

    • If nothing is common depth/prefix depth is 0.

    • If directory number contains only comma separated values, it is the minimum number's digit length.

      • Single number
    Example:

    • If directory Number is 1000-1020 depth is 2 as common digits are 2

    • If 111,1120 then depth is 3. (Minimum digit length is preferred as the depth)

    • If 6500,7000 then depth is 4.

    • If 2000,2001,306-505(Nothing is common so depth is 0.)

    • If 3000-3002,2022-2030 (If both ranges have common digits at the beginning, then the minimum depth is preferred.) Here it is 2.

    >>extraDigits

    String

    Enter the Extra digits. It is the extension number.The digit may be used to make short numbers that are conflicting between ranges unique.The digit(s) will be wedged in between the prefix part and the internal part of the range. When Directory Numbers with the combination of commas(eg.1000,2000) are entered, then Extra Digit is not allowed.

    Format: Numerical value, 1 to 9999999999 digits

    Options:

    • Directory number length-Selected Prefix length + Extra digits(Extension number) length should not be more than 10 digits

    • The numbers can be entered as the following:

      • Single number

    Example: 5123456 (If directory Number is 1000-1020 and prefix selected is 1 then extra digits entered can have length upto 7 digits.)(4-1 + extra Digits length = 10)

    Maximum Length: 10

    Minimum Length: 0

    Pattern: ^[^ ,"\\&><?*]([^,"\\&><?*])*$

    >commonAbbreviatedNumbers

    String

    Enter Common abbreviated number or common abbreviated numbers for a customer group.

    Format: Numerical value, 2 to 20 digits

    Options: Available numbers in the range 00-99999999999999999999. The numbers can be entered as the following:

    • Single number

      Example: 101

    • Ranges

      Example: 205-207

    Directory Numbers:

    Common Abbreviated Numbers consists of two parts: The first part is the tenant prefix and the second part is the extension number/Extra Digits. Prefix Length Extra Digits.

    Note: This parameter is mandatory.

    >>prefixLength

    integer($int32)

    Enter the depth or prefix length. The Prefix Length is the number of digits that needs to be removed from the tenant prefix of the Directory numbers. Prefix depth/length defines the boundary between prefix and internal (short) number within a range.

    Options:

    • Available Prefix Length which is derived based on the entered directory Number.

    • The prefix length will be the length of the common numbers of the start and stop number range.

    • If nothing is common depth/prefix depth is 0.

    • If directory number contains only comma separated values, it is the minimum number's digit length.

      • Single number
    Example:

    • If directory Number is 1000-1020 depth is 2 as common digits are 2

    • If 111,1120 then depth is 3. (Minimum digit length is preferred as the depth)

    • If 6500,7000 then depth is 4.

    • If 2000,2001,306-505(Nothing is common so depth is 0.)

    • If 3000-3002,2022-2030 (If both ranges have common digits at the beginning, then the minimum depth is preferred.) Here it is 2.

    >>extraDigits

    String

    Enter the Extra digits. It is the extension number.The digit may be used to make short numbers that are conflicting between ranges unique.The digit(s) will be wedged in between the prefix part and the internal part of the range. When Directory Numbers with the combination of commas(eg.1000,2000) are entered, then Extra Digit is not allowed.

    Format: Numerical value, 1 to 9999999999 digits

    Options:

    • Directory number length-Selected Prefix length + Extra digits(Extension number) length should not be more than 10 digits

    • The numbers can be entered as the following:

      • Single number

    Example: 5123456 (If directory Number is 1000-1020 and prefix selected is 1 then extra digits entered can have length upto 7 digits.)(4-1 + extra Digits length = 10)

    Maximum Length: 10

    Minimum Length: 0

    Pattern: ^[^ ,"\\&><?*]([^,"\\&><?*])*$

    >subscribers

    >>numberRange

    String
    Enter a telephony server on which the extension will be initiated.
    Note: This parameter is mandatory.

    >>featurelevel

    String
    Enter the Feature Levels from string.List of all Feature Levels (Alias names)available in license file for that particular MiVoice MX-ONE. For more information on the feature level, see Figure 1.
    Note: This parameter is mandatory.

    >>dialingPrivileges

    String

    Enter the Dialing Privileges from string.When Dialing Privilege is selected, a CSP corresponding to that privilege is chosen for creating an extension.

    Options:

    • Internal

    • Regional

    • National

    • International

    Note: This parameter is mandatory.

    >>endUserDeviceType

    String

    Enter the End User Device Type/Phone type from string.For feature level as BASIC, phone type cannot be selected as BluStar Client.

    Options:

    • Mitel 6863i

    • Mitel 6865i

    • Mitel 6867i

    • Mitel 6869i

    • BluStar Client

    For feature level as BASIC, phone type cannot be selected as BluStar Client.
    Note: This parameter is mandatory.
    The following figure depicts the feature level for subscribers.
    Figure 1. featurelevel

  6. Click on Execute to generate the request URL.

    Request URL:
    https://<IP_Address>:<PORT>/tenant/tenant-configuration/v1
    The following table lists the expected responses.

    Response Type

    Value

    Schema

    Valid Response

    201 Created

    		 
    {
  "mxoneSubsystem": "string",
  "customerNumber": 0,
  "customerName": "string",
  "acronym": "string",
  "domainName": "string",
  "domainOwner": true,
  "restrictTerminalRegistrationFromForeignIPDomains": true,
  "enableShortUserIdFormat": true,
  "exceptionForDialingNumbers": "string",
  "allowDirectCallsBetweenCustomers": true,
  "financeId": "string",
  "directoryNumbers": [
    {
      "directoryNumbers": "string",
      "prefixLength": 0,
      "extraDigits": "string"
    }
  ],
  "commonAbbreviatedNumbers": [
    {
      "commonAbbreviatedNumbers": "string",
      "prefixLength": 0,
      "extraDigits": "string"
    }
  ],
  "subscribers": [
    {
      "numberRange": 0,
      "featurelevel": "string",
      "dialingPrivileges": "Internal",
      "endUserDeviceType": "Mitel 6863i"
    }
  ]
}

    Error Response

    400 Bad Request

    Not applicable

    401 Authentication Failure

    Not applicable

    403 Forbidden

    Not applicable

    404 Not found

    Not applicable
Parent topic: Tenant Configuration
↑