Get Details for Specific Service

The Get Details for Specific Service request retrieves the details of a specific service. Use this request to retrieve detailed information for the service.

URI

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

HTTP Method

GET

Request Headers

You can alternatively specify either of the following headers, both of which return identical output.

Attribute

Type

Description

X-Ovoc-Channel-Id

integer

The Live Platform channel id. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

X-IAM-Account-Id

string

The Live Platform iamAccountId of the channel. When specified, data is scoped to only customers belonging to the specified channel. See Get List of Channels to extract this value.

Request Parameters

Parameter

Type

Description

CustomerGuid

string ($uuid)

The umpCustomerGuid created in the Live Platformcustomer 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 Platformcustomer 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.

LiveHubSimpleUsersCount

integer

System fields used in communication with Live Hub.

siteLocation (SIP Connection)

dictionary

■ 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

integer

One of the following values:

■ SIP Trunk: SIP Trunk used by the Service Provider. When this option is selected, you must select both the SBC device (see 'Region' field below) and the Service Provider Carrier SIP Trunk (see additionalProp1 parameter below).
■ BYOC: (Bring-Your-Own-Carrier) for integrating customer SIP Trunk services that are different to the SIP Trunk service used by the Service Provider. When this option is selected, you must select both the SBC device (see 'Region' field below) and the Service Provider Carrier SIP Trunk (see 'additionalProp2' parameter below).
■ IP-PBX: Service Provider IP-PBX. When this option is selected, you must select both the SBC device and the Service Provider Carrier SIP Trunk (see 'additionalProp3' parameter below).

This value is currently not supported.

 

MsDefaultDomain

string

System field.

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.

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.

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.

This field is applicable only to the Pro- and Plus-licensed services with application registration.
■ 404 Not Found: For example "Request headers specified for channel do not exist, results in error "No Customer Found"

Parameter

Type

Description/Examples

errors

string

 Text description of the error.

type

string

"https://tools.ietf.org/html/rfc7231#section-6.5.1"

title

string

Email title. For example "One or more validation errors occurred."

status

error code

HTML error code i.e. 400

detail

string

Additional error details.

traceId

string

Error trace Id

instance

string

Error instance

errorTicket

string

This field may not appear for all return codes.

errorCode

string

This field may not appear for all return codes.

additionalProp1

string

Custom Script variable argument. For example "CacProfile": "5 sessions"

additionalProp2

string

Custom Script argument. For example, ProxySet": "SIPTrunk"

additionalProp3

string

Custom Script argument. For example, "OnlinePstnGateway": "sandbox1.audiocodes.be"
■ 500 Internal Server Error:
Copy 
{
"title": "Failed to retrieve customer information",
"status": 500,
"detail": "ErrorTicket=9ce0708c-9de2-44c9-9daf-0aa81b90bd76"
}