Get Details for Specific Service

The Get Details for Specific Service request retrieves the details of a specific customer. Once the customer has been created, retrieve it to verify the details.

URI

Copy 
{{baseUrl}}/api/v3/customer/{UmpCustomerGuid}

HTTP Method

GET

Request Parameters

Parameter

Type

Description

CustomerGuid

string ($uuid)

umpCustomerGuid created in the Live Platform customer tenant SQL database :

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

allDetails

boolean

Default: false

When enabled retrieves the Site Locations array (SIP Connections) for the specific customer.

Example Response

Example of a response for a request without allDetails or allDetails=false in query string:

Copy 
{
    "UmpCustomerGuid": "a2a3f4c1-38a9-4709-a1be-0c99d02dd5a2",
    "CustomerShortName": "BradOCDev1",
    "CustomerFullName": "BradOCDev1",
    "LicenseType": 4,
    "LicensedUsersCount": 20,
    "MsTenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0,
    "MsDefaultDomain": null,
    "ApplicationClientId": "b6739dd5-de8d-4584-91c9-2e83cd8443bc",
    "ApplicationClientSecret": "~-6",
    "ClientSecretExpirationDate": "2/18/2027 8:39:26 AM"
}

Example of a response for a request with allDetails=true included in the query string:

Copy 
{
    "UmpCustomerGuid": "a2a3f4c1-38a9-4709-a1be-0c99d02dd5a2",
    "CustomerShortName": "BradOCDev1",
    "CustomerFullName": "BradOCDev1",
    "LicenseType": 4,
    "LicensedUsersCount": 20,
    "MsTenantId": "3bc57cac-5794-457f-ad36-2c88cade9dbb",
    "ActiveUserCount": 0,
    "LiveHubActiveUsersCount": 0,
    "LiveHubSimpleUsersCount": 0,
    "SiteLocation": [
        {
            "id": "8a97168c-f8a0-485b-a95e-8127d0a9adfe",
            "name": "GSDBFWQOQNJGG",
            "sbcId": 7,
            "sbcDeploymentState": "Deployed",
            "sbcConfigurationType": "SipTrunk"
        },
        {
            "id": "ae7735ca-6cb3-45f5-96cb-858e1552958e",
            "name": "GSDBFWQOQNKEF",
            "sbcId": 12,
            "sbcDeploymentState": "Deployed",
            "sbcConfigurationType": "SipTrunk"
        },
        {
            "id": "ccc7deb3-b118-4f29-9d3f-6446513130b0",
            "name": "GSDBFWQOQNKSC",
            "sbcId": 8,
            "sbcDeploymentState": "Deployed",
            "sbcConfigurationType": "SipTrunk"
        },
        {
            "id": "dea511cf-d76b-4763-8767-a3895b56a81f",
            "name": "GSDBFWQOQNOIA",
            "sbcId": 11,
            "sbcDeploymentState": "Deployed",
            "sbcConfigurationType": "SipTrunk"
        }
    ],
    "MsDefaultDomain": null,
    "ApplicationClientId": "b6739dd5-de8d-4584-91c9-2e83cd8443bc",
    "ApplicationClientSecret": "~-6",
    "ClientSecretExpirationDate": "2/18/2027 8:39:26 AM"
}

HTTP Responses

■ 200 OK

Parameter

Type

Description

Id

string($uuid)

'umpCustomerGuid' value created in the Live Platform customer tenant SQL database directory:

■ Operator Connect: A new OC Essentials service is created when a license is applied to the lead using Create Service from Lead Overview). If this field is null, a license has not yet been applied to the lead.
■ Direct Routing: A new Hosted Essentials service is created by Create Hosted Essentials Service.

This value is also retrieved using Get Services Brief Details (V3) and Get Customers Brief Details (V2) and in the 'Get Task' response when the customer service is created.

shortName

string

Short name of service complying with the following validation rules:

■ 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 full name of the service defined upon service creation.

licenseType

integer Enum:

[3, 4, 5]

[ 0, 1, 2]

One of the following values:

■ Hosted Essentials: 0
■ Hosted Essential Plus: 1
■ Hosted Pro: 2
■ OC Essential: 3
■ OC Essential Plus: 4
■ OC Pro: 5

licensedUsersCount

integer

Number of licensed users.

msTenantId

string

Microsoft subscription Tenant ID of the customer attached to the service.

LiveHubActiveUsersCount

integer

System fields used in communication with Live Hub.

LiveHubSimpleUsersCount

integer

System fields used in communication with Live Hub.

siteLocation (SIP Connection)

Array including the following:

■ id: string($uuid)
■ name: string
■ sbcId: integer
■ sbcDeploymentState: string

The configured SBC used to manage calls for this SIP Connection.

id

string($uuid)

The unique id for the SIP Connection (site location). Equivalent to value 'siteGuid' created when adding the SIP Connection.

name

string

Name of the SIP Connection.

sbcId

integer

Id of the SBC device in the Live Platform SQL database (see Get SBC Devices.

sbcdeploymentState

string

Deployment state of the tenant. One of the following values:

■ Draft
■ Submitted
■ Deploying
■ Deployed
■ Error
■ ReadyForDeployment
■ ReadyForRemove
■ Removing
■ Removed

sbcConfigurationType

string

Site configuration type which can be one of the following values:

■ Unknown=0
■ SipTrunk=1
■ IpPbx=2
■ Byoc=”

MsDefaultDomain

string

System field.

Note: This field is applicable only to the Pro- and Plus-licensed services with application registration.

ApplicationClientId

integer

ID of the application used during creating or upgrading this service.

Note: This field is applicable only to the Pro- and Plus-licensed services with application registration.

ApplicationClientSecret

string

The first three characters of the client secret of the application that was used during creating or upgrading this service.

Note: This field is applicable only to the Pro- and Plus-licensed services with application registration.

ClientSecretExpirationDate

string

Expiration date of the client secret in Microsoft.

Note: This field is applicable only to the Pro- and Plus-licensed services with application registration.
■ 500 Internal Server Error:
Copy 
{
"title": "Failed to retrieve customer information",
"status": 500,
"detail": "ErrorTicket=9ce0708c-9de2-44c9-9daf-0aa81b90bd76"
}