Get Details for Specific Service (Live Platform Id)
The Get Details for Specific Service (Live Platform Id) request retrieves the details of a specific service using the Live Platform Id. Use this request to retrieve detailed information for the service.
URI
{{baseUrl}}api/ovoc/v1/topology/services/<id>
HTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
<id> |
string |
Id of the Service in Live Platform portal. |
Example Response
Example of a response for a request without allDetails or allDetails=false in query string:
{
"services": [
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 8,
"meeting": 14
},
"maxDevicesMeeting": 200,
"maxDevicesPersonal": 200,
"devicesPercentagePersonal": 4,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/20f45b4e-9389-4afd-bc0d-384f6d375810/",
"devicesPercentageMeeting": 7,
"disconnectedDevices": {
"personal": 3,
"meeting": 3
}
},
"lcCustomerId": 79192,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
42713
],
"licenseType": "PRO_IMTR",
"attachedLinks": [],
"serviceUcaasTenantId": "a4c1032c-9111-4174-8202-06a56c5b50e3",
"id": 42712,
"serviceId": "20f45b4e-9389-4afd-bc0d-384f6d375810",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-03-15T10:37:35.820+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "DHD Customer A DM",
"usersCount": null,
"serviceName": "customera-dm",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/42712",
"lastBackupTime": null,
"umpId": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "customera-dm",
"tenantId": 1,
"parameters": [
{
"name": "Max AI Summary Devices",
"type": "Integer",
"value": 5
},
{
"name": "Active AI Summary Devices",
"type": "Integer",
"value": 2
},
{
"name": "AI Summary Status",
"type": "String",
"value": "enabled"
},
{
"name": "email",
"type": "String",
"value": "dhdeang@audiocodes.com"
},
{
"name": "Trial Status",
"type": "String",
"value": "enabled"
},
{
"name": "Trial Expiry Date",
"type": "String",
"value": "19-07-2026"
},
{
"name": "Trial Start Date",
"type": "String",
"value": "20-01-2026"
}
],
"status": "ERROR"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 0,
"meeting": 0
},
"maxDevicesMeeting": 10,
"maxDevicesPersonal": 10,
"devicesPercentagePersonal": 0,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/675426ad-958e-4c4e-8d67-0d7b35d4c48b/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 0,
"meeting": 0
}
},
"lcCustomerId": 97884,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "OK",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
53905
],
"licenseType": "ESSENTIAL",
"attachedLinks": [],
"serviceUcaasTenantId": "5bfd35ae-875a-4f06-8df8-6f916432909c",
"id": 53904,
"serviceId": "675426ad-958e-4c4e-8d67-0d7b35d4c48b",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-05-16T12:51:37.590+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "CarlDMDemo",
"usersCount": null,
"serviceName": "CarlDMDemo",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/53904",
"lastBackupTime": null,
"umpId": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "CarlDMDemo",
"tenantId": 1,
"parameters": null,
"status": "OK"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 0,
"meeting": 0
},
"maxDevicesMeeting": 10,
"maxDevicesPersonal": 10,
"devicesPercentagePersonal": 0,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/da2d3e2f-0a1e-4fa1-afcd-74051107bb95/",
"devicesPercentageMeeting": 0,
"disconnectedDevices": {
"personal": 0,
"meeting": 0
}
},
"lcCustomerId": 97885,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "OK",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
54019
],
"licenseType": "ESSENTIAL",
"attachedLinks": [],
"serviceUcaasTenantId": "c1341d1d-2cf8-417a-95fc-69a05a2c0d11",
"id": 54018,
"serviceId": "da2d3e2f-0a1e-4fa1-afcd-74051107bb95",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-05-29T11:56:28.410+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "Ami customer",
"usersCount": null,
"serviceName": "Ami_customer",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/54018",
"lastBackupTime": null,
"umpId": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "Ami_customer",
"tenantId": 1,
"parameters": null,
"status": "OK"
},
{
"elementsCount": {
"total": 1,
"devices": 0,
"links": 0,
"sites": 1
},
"deviceManagerParams": {
"deviceType": "PERSONAL_AND_MEETING",
"password": null,
"devicesCount": {
"personal": 10,
"meeting": 33
},
"maxDevicesMeeting": 150,
"maxDevicesPersonal": 100,
"devicesPercentagePersonal": 10,
"user": null,
"serviceDeviceUrl": "https://sandbox3.finebak.com/ltcfordevice/c/2913e267-ccab-4974-9d71-462eed586b93/",
"devicesPercentageMeeting": 22,
"disconnectedDevices": {
"personal": 6,
"meeting": 18
}
},
"lcCustomerId": 61954,
"umpUsersSuspendAlarmStatus": 0,
"description": null,
"type": "SERVICE",
"applicationsStatus": {
"management": {
"managementStatus": "ERROR",
"serviceDeployStatus": "DEPLOYED"
},
"voiceQuality": {
"teamsVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
},
"voiceQualityStatus": "UNMONITORED",
"alertRuleVoiceQualityStatus": "UNMONITORED",
"sbcVoiceQualityJson": {
"vqControlStatus": "UNMONITORED",
"vqMediaStatus": "UNMONITORED",
"voiceQualityStatus": "UNMONITORED"
}
}
},
"attachedSites": [
55150
],
"licenseType": "ESSENTIAL_IMTR",
"attachedLinks": [],
"serviceUcaasTenantId": "67fea0c1-0319-4f7c-9ae0-7f7de75dbcdd",
"id": 55149,
"serviceId": "2913e267-ccab-4974-9d71-462eed586b93",
"disabledTime": null,
"usedDIDs": 0,
"definedAt": "2023-07-09T13:17:23.628+0000",
"serviceSource": "DM",
"freeDIDs": 0,
"attachedDevices": [],
"fullName": "Seraya",
"usersCount": null,
"serviceName": "Seraya",
"umpUsersCount": 0,
"url": "/ovoc/v1/topology/services/55149",
"lastBackupTime": null,
"umpId": null,
"isEnabled": true,
"totalDIDs": 0,
"name": "Seraya",
"tenantId": 1,
"parameters": [
{
"name": "Max AI Summary Devices",
"type": "Integer",
"value": 150
},
{
"name": "Active AI Summary Devices",
"type": "Integer",
"value": 21
},
{
"name": "AI Summary Status",
"type": "String",
"value": "enabled"
},
{
"name": "email",
"type": "String",
"value": "maximge@audiocodes.com"
},
{
"name": "Trial Status",
"type": "String",
"value": "enabled"
},
{
"name": "Trial Expiry Date",
"type": "String",
"value": "06-06-2026"
},
{
"name": "Trial Start Date",
"type": "String",
"value": "08-12-2025"
}
],
"status": "ERROR"
},
HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
|||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
elementsCount |
dictionary |
|
|||||||||||||||||||||
|
total |
integer |
The total number of entities deployed for the service. |
|||||||||||||||||||||
|
devices |
integer |
The total number of devices deployed for the service. |
|||||||||||||||||||||
|
links |
integer |
The total number of links deployed for the service. |
|||||||||||||||||||||
|
sites |
integer |
The total number of sites deployed for the service. |
|||||||||||||||||||||
|
lcCustomerId |
integer |
Id of the Live Platform customer |
|||||||||||||||||||||
|
umpUsersSuspendAlarmStatus |
integer |
?? |
|||||||||||||||||||||
|
description |
string |
Brief customer description |
|||||||||||||||||||||
|
type |
string |
Service |
|||||||||||||||||||||
|
applicationsStatus |
dictionary |
|
|||||||||||||||||||||
|
management |
dictionary |
managementStatus |
|||||||||||||||||||||
|
managementStatus |
string |
Statuses for the Live Platform Portal Management entity:
|
|||||||||||||||||||||
|
voiceQuality |
dictionary |
|
|||||||||||||||||||||
|
attachedSites |
list array |
List of Ids for attached SIP connections. |
|||||||||||||||||||||
|
licenseType |
string |
License type of the service. |
|||||||||||||||||||||
|
attachedLinks |
list array |
List of Ids for attached links. |
|||||||||||||||||||||
|
serviceUcaasTenantId |
string |
?? |
|||||||||||||||||||||
|
id |
long |
Id of the service |
|||||||||||||||||||||
|
serviceId |
string |
Microsoft Entra Tenant ID of the service |
|||||||||||||||||||||
|
disabledTime |
($date-time) |
|
|||||||||||||||||||||
|
usedDIDs |
integer |
The total number of DIDs that are assigned to users of the customer tenant for the service. |
|||||||||||||||||||||
|
definedAt |
$date-time |
The date and time of the creation of the service. |
|||||||||||||||||||||
|
serviceSource |
string |
The type of service |
|||||||||||||||||||||
|
freeDIDs |
integer |
The number of unused DIDs for the customer tenant service (DIDs that have been uploaded to the service however have not yet been assigned to users). |
|||||||||||||||||||||
|
attachedDevices |
list array |
List of Ids of devices that are attached to the service. |
|||||||||||||||||||||
|
fullName |
string |
Full customer name. |
|||||||||||||||||||||
|
usersCount |
integer |
The total number of licensed users of the customer tenant service. |
|||||||||||||||||||||
|
serviceName |
string |
The name of the service. |
|||||||||||||||||||||
|
url |
url |
The Rest URL for performing actions on the service. /ovoc/v1/topology/services/<serviceid> |
|||||||||||||||||||||
|
lastBackupTime |
$date-time |
The date and time of the last backup of the service. |
|||||||||||||||||||||
|
isEnabled |
boolean |
Indicates whether the product license is enabled for the service. |
|||||||||||||||||||||
|
totalDIDs |
integer |
The number of DIDs including used and unused (the total number of DIDs that are uploaded to the customer service). |
|||||||||||||||||||||
|
name |
string |
The name of the service. |
|||||||||||||||||||||
|
tenantId |
string |
The Microsoft Entra Tenant Id of the customer. |
|||||||||||||||||||||
|
parameters (Service Details) |
list array |
|
|||||||||||||||||||||
|
CAC Profile |
string |
The name of the CAC profile attached to the service. |
|||||||||||||||||||||
|
Carrier Id |
string |
The Carrier Id attached to the service. |
|||||||||||||||||||||
|
Last Backup Time |
string ($date-time) |
The Last Backup Time of the service. |
|||||||||||||||||||||
|
Used DIDs |
integer |
The total number of DIDs that are assigned to users of the customer tenant service. |
|||||||||||||||||||||
|
Unused DIDs |
integer |
The total number of DIDs that are not yet assigned to users of the customer tenant service. |
|||||||||||||||||||||
|
Total DIDs |
integer |
The total number of assigned and not assigned DIDs of the customer tenant service. |
|||||||||||||||||||||
|
Users Count |
integer |
The total number of licensed users of the customer tenant service. |
|||||||||||||||||||||
|
Device Manager parameters |
|
|
|||||||||||||||||||||
|
Max AI Summary Devices |
integer |
The maximum number of supported devices for the AI Summary license. |
|||||||||||||||||||||
|
Active AI Summary Devices |
integer |
The number of devices with the AI Summary feature activated. |
|||||||||||||||||||||
|
AI Summary Status |
string |
Status of the AI Summary Status service |
|||||||||||||||||||||
|
|
string |
Email of the customer admin |
|||||||||||||||||||||
|
Trial Status |
string |
Status of the trial period for the AI Summary feature. |
|||||||||||||||||||||
|
Trial Expiry Date |
string |
Expiration date for the trial period of the AI Summary feature. |
|||||||||||||||||||||
|
Trial Start Date |
string |
Start date for the trial period of the AI Summary feature. |
|||||||||||||||||||||
|
status |
string |
Management status of the customer:
|
| ■ | 400: Bad Request (e.g., empty request body) |
| ■ | 404: Resource not found or belongs to a different tenant |
| ■ | 409: Conflict when tenant ID validation fails |
| ■ | 500: Internal server error or communication error with Live Platform portal |
| ■ | 503: Service Unavailable when Live Platform portal is not configured |