Get Specific Channel Details
The Get Specific Channel Details request retrieves the details of a specific channel defined in Live Platform. See also Channel Management.
URI
{{baseUrl}}/api/ovoc/v1/topology/channels/{id:int}HTTP Method
GET
Request Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
{id:int} |
long |
Channel Id |
Example Response
{
"definedAt": "2025-08-12T07:02:10.822+0000",
"adGroupName": null,
"dmSourceEmail": null,
"iamAccountId": "80737ce0-dab9-4c38-b894-8d2084d01866",
"lastChanged": "2025-11-16T16:20:05.808+0000",
"description": "Roy MY Channel as Service Provider",
"maxCustomers": 0,
"services": {
"LIVE_CX": {
"meteringTag": "",
"enabled": true
},
"WEBEX_CLOUD_CONNECT": {
"meteringTag": "",
"enabled": true
},
"MI_REGIONAL": {
"meteringTag": "",
"enabled": false,
"info": {}
},
"DM": {
"meteringTag": "",
"enabled": true
},
"LIVEHUB": {
"meteringTag": "",
"enabled": false
},
"GENERIC": {
"meteringTag": "",
"enabled": true
},
"STNG_REGIONAL": {
"meteringTag": "",
"enabled": false
},
"OC": {
"meteringTag": "",
"enabled": true
},
"SMART_TAP": {
"enabled": false
},
"WEBEX_LGW": {
"meteringTag": "",
"enabled": true
},
"MEETING_INSIGHTS": {
"meteringTag": "",
"enabled": true,
"info": {
"enableCustomTemplateManagement": false
}
},
"ZOOM": {
"meteringTag": "",
"enabled": true
},
"LTC": {
"meteringTag": "",
"enabled": true
},
"STNG": {
"meteringTag": "",
"enabled": false
},
"HYBRID_ENTITIES": {
"meteringTag": "",
"enabled": true
},
"VOCA": {
"meteringTag": "",
"enabled": false,
"info": {
"subRegionalVocaIds": []
}
}
},
"adGroupId": null,
"url": "/ovoc/v1/topology/channels/1315855",
"msTenantId": "65473cee-4b18-461b-8bb3-66e9e1f8762c",
"vocaProviderId": null,
"servicesNumber": 10,
"appRegistrationSettings": {
"msTenantId": "65473cee-4b18-461b-8bb3-66e9e1f8762c",
"clientId": "",
"cloudUrl": "https://login.microsoftonline.com/",
"displayName": null,
"identityAuthority": "MS_ENTRA_PUBLIC",
"urlMode": "organizations",
"clientSecret": "",
"portalFqdn": "",
"isEnable": false
},
"name": "RoyChannel",
"tenantId": 508,
"id": 1315855,
"customers": [
1315804
],
"isCommitmentApproved": false,
"logoId": 579,
"contacts": {
"secondaryEmail": null,
"phone": null,
"generalInfo": null,
"email": null,
"secondaryPhone": null
}
}HTTP Responses
| ■ | 200 OK |
|
Parameter |
Type |
Description |
|||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
definedAt |
string($date-time) |
Date and time of the creation of the customer entity in Live Platform Operation Center. |
|||||||||||||||||||||||||||
|
adGroupName |
String (0-150) |
Azure Active Directory Group mapping if configured (seeAdd Channels ). |
|||||||||||||||||||||||||||
|
dmSourceEmail |
|
Source email of the Channel Admin if configured. |
|||||||||||||||||||||||||||
|
iamAccountId |
string (0-255) |
IAM account number of the customer in Live Platform Operation Center. |
|||||||||||||||||||||||||||
|
lastChanged |
string($date-time) |
Date and time of the last modification of the channel. |
|||||||||||||||||||||||||||
|
description |
String (0-250) |
Short text description of the channel. |
|||||||||||||||||||||||||||
|
maxCustomers |
integer |
The maximum number of customers that can be attached to the channel. |
|||||||||||||||||||||||||||
|
services |
dictionary |
Dictionary including the following parameters:
|
|||||||||||||||||||||||||||
|
meteringTag |
string |
Metering tag of the channel |
|||||||||||||||||||||||||||
|
enabled |
boolean |
Indicates whether the specific service is enabled. |
|||||||||||||||||||||||||||
|
enableCustomTemplateManagement |
boolean |
Indicates whether Custom templates have been enabled for the service (Meeting Insights and Interaction Insights). |
|||||||||||||||||||||||||||
|
info |
dictionary |
Dictionary including a list of subRegionalVocaIds (see below) |
|||||||||||||||||||||||||||
|
subRegionalVocaIds (Voca) |
string |
List of Voca subRegionalVocaIds |
|||||||||||||||||||||||||||
|
adGroupId |
string |
Id of the mapped Azure Active Directory Group mapping if configured (seeAdd Channels ). |
|||||||||||||||||||||||||||
|
url |
string |
Rest URL for retrieving information on the channel. /ovoc/v1/topology/lcCustomers/<channelId> |
|||||||||||||||||||||||||||
|
msTenantId |
string |
The Microsoft Tenant ID of the channel. |
|||||||||||||||||||||||||||
|
vocaProviderId |
String (0-255) |
The Id of the Voca Service Provider to which the channel is attached. |
|||||||||||||||||||||||||||
|
servicesNumber |
Integer (0-Max Int) |
The number of services deployed for the channel. |
|||||||||||||||||||||||||||
|
appRegistrationSettings |
dictionary |
If a White-label app registration exists for the channel, includes the following dictionary:
|
|||||||||||||||||||||||||||
|
msTenantId |
string (0-255) |
Microsoft Entra Tenant Id |
|||||||||||||||||||||||||||
|
clientId |
string (0-255) |
Microsoft Entra ID Application (Client) Id of the Live Platform portal registration. |
|||||||||||||||||||||||||||
|
cloudUrl |
string (0-255) |
Login URL to Microsoft Entra ID: https://login.microsoftonline.com/ |
|||||||||||||||||||||||||||
|
displayName |
string (0-255) |
The Display name of the White-label app registration. |
|||||||||||||||||||||||||||
|
identityAuthority |
string |
MS_ENTRA_PUBLIC |
|||||||||||||||||||||||||||
|
urlMode |
AzureADPathType |
|
|||||||||||||||||||||||||||
|
clientSecret |
string (0-255) |
The Client secret of the White-label app registration. |
|||||||||||||||||||||||||||
|
portalFqdn |
string (0-255) |
The White-label FQDN of the channel. |
|||||||||||||||||||||||||||
|
isEnable |
boolean (default: false) |
Indicates whether the Custom App registration is enabled for the channel. |
|||||||||||||||||||||||||||
|
name |
string (0-255) |
Name of the channel |
|||||||||||||||||||||||||||
|
tenantId |
string |
The Microsoft tenant Id of the White-label channel. |
|||||||||||||||||||||||||||
|
id |
long |
Channel Id |
|||||||||||||||||||||||||||
|
customers |
array of Long IDs of the services that are deployed for the customer. |
List of Ids of attached customers. |
|||||||||||||||||||||||||||
|
isCommitmentApproved |
boolean (default: false) |
This setup requires a separate Microsoft tenant license and you must also ensure that the White-label FQDNs are added to your DNS server. For more information, contact AudioCodes services. |
|||||||||||||||||||||||||||
|
logoId |
long |
Id of the logo attached to the customer |
|||||||||||||||||||||||||||
|
contacts |
dictionary |
Contact details of the customer:
|
|||||||||||||||||||||||||||
|
secondaryEmail |
string (0-255) |
Customer Secondary email address. |
|||||||||||||||||||||||||||
|
phone |
string (0-255) |
Customer phone number. |
|||||||||||||||||||||||||||
|
generalInfo |
string (0-255) |
General information used by AudioCodes services. |
|||||||||||||||||||||||||||
|
|
string (0-255) |
Customer email address. |
|||||||||||||||||||||||||||
|
secondaryPhone |
string (0-255) |
Customer Secondary phone number. |