Create Essentials Customer

This request creates a new customer with a single site location and with the Hosted Essentials license type.

URL

Copy 
{{baseUrl}}/api/v2/customer

HTTP Method

POST

Request Body

Parameter

Type

Description

shortName

string

Short customer name, complying with validation rules for customer name:

■ The string should be 3-15 characters long
■ The following characters cannot be used: \ / : * ? " < > |audit
■ Can contain letters (lower/UPPER case), Numbers and special characters are allowed, however cannot contain the dot (.) or blank spaces.
■ Unique name per M365 Tenant

fullName

string

The customer full name (optional).

siteLocation

list array

The site location represents a an SBC configuration for a specific customer. This list array includes the following parameters:

■ sbcid
■ sbcOnboardingScript
■ sbcCleanupScript

sbcId

integer

The SBC Id in the SBC List (Known SBCs). For more information, see Managing SBC Devices.

sbcOnboardingScript

integer

The required value for an SBC Onboarding script. For more information, see SBC Template Scenarios.

sbcCleanupScript

integer

The required value for an SBC Cleanup script (see SBC Template Scenarios).

ovocCustomerType

string

One of the following values:

■ IPGROUP_TYPE
■ TENANT_TYPE
■ IPGROUP_TYPE: An IP Group is created for each new customer based on the Customer Shortname. This type is used for the Access Trunk Direct Routing (used for Direct Routing customers when SIP Registration is required). An link is established with the Live Platform server (OVOC) using this IP group.
■ Tenant ID:-The new customer is created based on the customer's Azure tenant subscription Id. A link is established with the Live Cloud server (OVOC) using this tenant Id.

channelId

string

 The channel Id of the tenant if existing. See Get List of Channels.

[CustomerVariableName]: Value String

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name
■ CAC Profile name "Number of CAC sessions" e.g. "10 sessions" (see Get SBC Devices)

Customer variables must be added to the Live Platform database. See Customer Variables.

[CustomerVariableName]: Value String

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name
■ CAC Profile name "Number of CAC sessions" e.g. "10 sessions" (see Get SBC Devices)

Customer variables must be added to the Live Platform database. See Customer Variables.

[CustomerVariableName]: Value String

string

One of the following values:

■ SBC name (Provider SIP Trunk, BYOC or IP-PBX)
■ Region name
■ Carrier name
■ CAC Profile name "Number of CAC sessions" e.g. "10 sessions" (see Get SBC Devices)

Customer variables must be added to the Live Platform database. See Customer Variables.

msTenantId

string

Enter Tenant Id of the customers' Microsoft Tenant Id for validation.

Example Body

Copy 
{
  "shortName": "BradSB1E1",
  "fullName": "BradSB1E1",
  "siteLocation": {
    "sbcId": 5,
    "sbcOnboardingScript": 7,
    "sbcCleanupScript": 700
  },
  "ovocCustomerType": "IPGROUP_TYPE",
  "msTenantId": "fcc608c4-095b-4d1a-90e3-2106fc7024de"
  

}

Example Response

Copy 
{
    "id": "182f496c-0aaa-4023-bdd4-03b9cf8f68b9",
    "customerId": "BradSB1E1",
    "siteLocationIds": [
        "e61d2f11-87ef-49f9-8771-730ec0b2507b"
    ],
    "deploymentState": "Deployed",
    "errorDetails": null,
    "progressDetails": "(Information, MsTenantid is valid);(Information, Customer data created!);(Information, SBC sbc-onboarding done for site BradSB1E1.);(Information, Site created in Ovoc)"
}

HTTP Responses

■ 200 OK

Parameter

Type

Description

customerGuid

string

Unique customer Id created by this request.

customerId

string

Customer ShortName

siteLocationIds

integer
■ For deployments with a single location, this value is identical to the 'customerGuid' value above.
■ For deployments with multiple locations, this value is unique.

deploymentState

string

One of the following values:

■ Unknown
■ Deployed

errorDetails

string

Error information.

progressDetails

string

Progress details regarding the deployment. See example below.

Copy 
Checking SBC IP Group Programming.SBC not programmed yet.Starting SBC Programming.Sbc is programmedSite location information saved.Customer created

If Live Platform (UMP-365) server is configured as a tenant in server, the sbcId must be the id of the SBC device registered in Live Platform (OVOC) server.