Download OpenAPI specification:Download
This is the Monitoring API definition for the Avaya Session Border Controller for Enterprise.
Each supported endpoint is defined in this file along with a description of the endpoint, any required parameters, permissions, and the expected responses with examples. Detailed information on how to fully configure a system from start to finish can be found in the Administering Avaya Session Border Controller for Enterprise document available on the Avaya Support site (see https://support.avaya.com/products/P0997/avaya-session-border-controller-for-enterprise/).
Note that each endpoint definition also includes an embedded x-required-capability
property which contains the
required permissions for the endpoint (this is also included in the description).
APIs for viewing system information, including installed applications and statuses.
Get an overview of the system hardware specifications.
User must have the system-overview:read
capability to perform this action.
{- "cpu": {
- "model": "Intel(R) Xeon(R) Gold 6132 CPU @ 2.60GHz",
- "coreCount": 4,
- "clockSpeedMhz": 2593.906
}, - "memory": {
- "totalBytes": 8070332416,
- "usedBytes": 1170894848,
- "freeBytes": 2871324672
}, - "disk": {
- "partitions": {
- "/": {
- "mountPoint": "/",
- "size": "5.9G",
- "percentUsed": "45%",
- "usedRawGb": 2.5,
- "availableRawGb": 3.1
}, - "/home": {
- "mountPoint": "/home",
- "size": "3.9G",
- "percentUsed": "2%",
- "usedRawGb": 0.064453125,
- "availableRawGb": 3.6
}, - "/boot": {
- "mountPoint": "/boot",
- "size": "488M",
- "percentUsed": "38%",
- "usedRawGb": 0.16503906,
- "availableRawGb": 0.2763672
}, - "/usr/local": {
- "mountPoint": "/usr/local",
- "size": "7.8G",
- "percentUsed": "27%",
- "usedRawGb": 2,
- "availableRawGb": 5.5
}, - "/archive": {
- "mountPoint": "/archive",
- "size": "95G",
- "percentUsed": "1%",
- "usedRawGb": 0.034179688,
- "availableRawGb": 90
}, - "/var": {
- "mountPoint": "/var",
- "size": "27G",
- "percentUsed": "1%",
- "usedRawGb": 0.203125,
- "availableRawGb": 25
}, - "/tmp": {
- "mountPoint": "/tmp",
- "size": "3.9G",
- "percentUsed": "1%",
- "usedRawGb": 0.00020599365,
- "availableRawGb": 3.7
}, - "/root2": {
- "mountPoint": "/root2",
- "size": "5.9G",
- "percentUsed": "1%",
- "usedRawGb": 0.000022888184,
- "availableRawGb": 5.6
}, - "/var/log": {
- "mountPoint": "/var/log",
- "size": "3.9G",
- "percentUsed": "5%",
- "usedRawGb": 0.14648438,
- "availableRawGb": 3.5
}, - "/boot/efi": {
- "mountPoint": "/boot/efi",
- "size": "511M",
- "percentUsed": "2%",
- "usedRawGb": 0.0056640627,
- "availableRawGb": 0.49414062
}, - "/var/log/audit": {
- "mountPoint": "/var/log/audit",
- "size": "2.0G",
- "percentUsed": "55%",
- "usedRawGb": 0.9736328,
- "availableRawGb": 0.8125
}
}
}, - "nic": {
- "count": 6
}, - "bios": {
- "vendor": "VMware, Inc.",
- "version": "VMW71.00V.11599183.B64.1901030933"
}, - "os": {
- "name": "Red Hat Enterprise Linux",
- "version": "8.4 (Ootpa)",
- "bootMode": "UEFI",
- "kernel": {
- "name": "Linux",
- "release": "4.18.0-477.13.1.el8_8.x86_64",
- "version": "#1 SMP Thu May 18 10:27:05 EDT 2023"
}
}
}
Get a list of applications and the current status.
User must have the application-status:read
capability to perform this action.
[- {
- "name": "sshd",
- "displayName": "Secure Shell",
- "type": "SERVICE",
- "enabled": true,
- "running": true,
- "memoryUsage": 0.1,
- "memoryUsageRaw": 7876608,
- "cpuUsage": 0,
- "startTime": "2023-09-26T15:00:40Z",
- "uptime": "PT168H46M22S"
}, - {
- "name": "ipcs_pcf",
- "displayName": "PCF",
- "type": "KERNEL",
- "enabled": true,
- "running": true
}
]
Get an overview of the system hardware specifications.
User must have the installed-application:read
capability to perform this action.
[- {
- "packageName": "kernel",
- "displayName": "Kernel",
- "version": "4.18.0-477.13.1.el8_8"
}, - {
- "packageName": "pcf-module",
- "displayName": "PCF Module",
- "version": "10.2.0.0-23480"
}
]
Get the current status of packet capture.
User must have the packet-capture:read
capability to perform this action.
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
Start or stop a packet capture.
WARNING: Starting or stopping packet capture in quick succession. It is recommended to wait at least 5-10 seconds after starting a capture before attempting to stop it.
Note: While running a packet capture, all fields except the capturing
field will be ignored as changing
settings during an active capture is not supported.
User must have the packet-capture:update
capability to perform this action.
Parameters to use to configure the packet capture. All parameters are optional, however all parameters except
capturing
will be ignored while a packet capture is active.
capturing | boolean Current status of the packet capture (is it currently capturing?) |
interfaceName | string Name of the interface the packet capture will be performed on. |
localTarget | string Local IP the packet capture will listen on. Note: This should be a valid IP address or a valid IP and port combination. A wildcard value is allowed here to listen on any IP address (or to only listen on a specific port). |
remoteTarget | string Remote IP the packet capture will listen on. Note: This should be a valid IP address or a valid IP and port combination. A wildcard value is allowed here to listen on any IP address (or to only listen on a specific port). |
protocol | string Enum: "ANY" "TCP" "UDP" Protocol the packet capture will listen on. |
packetCaptureLimit | integer <int32> Number of packets to capture before the capture will stop. Note: Capturing more than 10,000 packets may have an adverse effect on application performance. |
captureFilename | string Name of the output capture file name. Note: The extension is not required and may be omitted. |
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
Get a list of packet capture (.pcap
) files current available on this system.
User must have the packet-capture:read
capability to perform this action.
[- {
- "name": "string",
- "size": 0,
- "lastModified": "2019-08-24T14:15:22Z"
}
]
Get the contents of a specific packet capture (.pcap
) file on this system.
Note: This API directly returns .pcap
files in binary format and should be handled accordingly.
User must have the packet-capture:read
capability to perform this action.
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Delete a specific packet capture (.pcap
) file from this system.
User must have the packet-capture:delete
capability to perform this action.
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Get a list of statistics associated with the SIP Summary category.
User must have the statistics:read
capability to perform this action.
[- {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalDirectMediaCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.31.0",
- "displayName": "Total Direct Media Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveDirectMediaSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.32.0",
- "displayName": "Active Direct Media SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}
]
Get a specific counter in the SIP Summary category.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full SIP Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
mibNameOrOid required | string A |
{- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}
Get a list of statistics associated with the CES Summary category.
User must have the statistics:read
capability to perform this action.
[- {
- "mibName": "sbcTotal1xMCesUserLoginFailed",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.5.1.0",
- "displayName": "1XM User Logins Failed",
- "value": 0
}, - {
- "mibName": "sbcTotal1xMCesUserLoginSucceeded",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.5.2.0",
- "displayName": "1XM User Logins Succeeded",
- "value": 0
}
]
Get a specific counter in the CES Summary category.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full CES Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
mibNameOrOid required | string A |
{- "mibName": "sbcTotal1xMCesUserLoginFailed",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.5.1.0",
- "displayName": "1XM User Logins Failed",
- "value": 0
}
Get a list of statistics associated with the Transcoding Summary category.
User must have the statistics:read
capability to perform this action.
[- {
- "mibName": "ipcsTotalActiveTranscodingSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.1.0",
- "displayName": "Total Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcsTotalTranscodingSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.2.0",
- "displayName": "Total Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcsTotalTranscodingSessionsFailed",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.3.0",
- "displayName": "Total Transcoding Sessions Failed",
- "value": 0
}, - {
- "mibName": "ipcsTotalTranscodingSessionModifications",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.4.0",
- "displayName": "Total Transcoding Sessions Modifications",
- "value": 0
}, - {
- "mibName": "ipcsTotalTranscodingSessionModificationsFailed",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.5.0",
- "displayName": "Total Transcoding Sessions Modifications Failed",
- "value": 0
}
]
Get a specific counter in the Transcoding Summary category.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full Transcoding Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
mibNameOrOid required | string A |
{- "mibName": "ipcsTotalActiveTranscodingSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.6.1.0",
- "displayName": "Total Active Transcoding Sessions",
- "value": 0
}
Get a list of statistics associated with the License Summary category.
User must have the statistics:read
capability to perform this action.
[- {
- "mibName": "ipcsLicenseStandardSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.1.0",
- "displayName": "Standard Sessions Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicenseStandardSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.2.0",
- "displayName": "Standard Sessions In-Use",
- "value": 0
}, - {
- "mibName": "ipcsLicenseAdvancedSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.3.0",
- "displayName": "Advanced Sessions Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicenseAdvancedSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.4.0",
- "displayName": "Advanced Sessions In-Use",
- "value": 0
}, - {
- "mibName": "ipcsLicenseScopiaVideoSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.5.0",
- "displayName": "Scopia Video Sessions Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicenseScopiaVideoSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.6.0",
- "displayName": "Scopia Video Sessions In-Use",
- "value": 0
}, - {
- "mibName": "ipcsLicenseCesSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.7.0",
- "displayName": "CES Sessions Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicenseCesSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.8.0",
- "displayName": "CES Sessions In-Use",
- "value": 0
}, - {
- "mibName": "ipcsLicenseTranscodingSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.9.0",
- "displayName": "Transcoding Sessions Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicenseTranscodingSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.10.0",
- "displayName": "Transcoding Sessions In-Use",
- "value": 0
}, - {
- "mibName": "ipcsLicensePremiumSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.11.0",
- "displayName": "Premium Session Reserved",
- "value": 0
}, - {
- "mibName": "ipcsLicensePremiumSessionInUseCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.12.0",
- "displayName": "Premium Session In-Use",
- "value": 0
}
]
Get a specific counter in the License Summary category.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full License Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
mibNameOrOid required | string A |
{- "mibName": "ipcsLicenseStandardSessionReservedCount",
- "oid": ".1.3.6.1.4.1.6889.2.77.11.1.0",
- "displayName": "Standard Sessions Reserved",
- "value": 0
}
Get a list of statistics associated with the each Subscriber Flow.
User must have the statistics:read
capability to perform this action.
{- "1": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
], - "2": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
}
Get a list of statistics associated with a specific Subscriber Flow based on its priority (identifier).
Note: This API endpoint is provided as a convenience and simply applies a filter to the full License Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
priority required | integer <int32> The flow priority used to identify the specific flow. |
[- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
Get a specific counter from a Subscriber Flow based on its priority (identifier).
Note: This API endpoint is provided as a convenience and simply applies a filter to the full License Summary counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
priority required | integer <int32> The flow priority used to identify the specific flow. |
mibNameOrOid required | string A |
{- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
Get a list of statistics associated with the each Server Flow.
User must have the statistics:read
capability to perform this action.
{- "1": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
], - "2": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
}
Get a list of statistics associated with a specific Server Flow based on its priority (identifier).
Note: This API endpoint is provided as a convenience and simply applies a filter to the full Server Flow counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
priority required | integer <int32> The flow priority used to identify the specific flow. |
[- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
Get a specific counter from a Server Flow based on its priority (identifier).
Note: This API endpoint is provided as a convenience and simply applies a filter to the full Server Flow counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
priority required | integer <int32> The flow priority used to identify the specific flow. |
mibNameOrOid required | string A |
{- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
Get a list of statistics associated with the each Endpoint Policy Group.
User must have the statistics:read
capability to perform this action.
{- "1": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
}
Get a list of statistics associated with a specific Endpoint Policy Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full Endpoint Policy Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific policy set. |
[- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
Get a specific counter from a Endpoint Policy Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full Endpoint Policy Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific policy set. |
mibNameOrOid required | string A |
{- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
Get a list of statistics associated with the each To URI Group.
User must have the statistics:read
capability to perform this action.
{- "2": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
}
Get a list of statistics associated with a specific To URI Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full To URI Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific uri group. |
[- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
Get a specific counter from a To URI Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full To URI Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific uri group. |
mibNameOrOid required | string A |
{- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
Get a list of statistics associated with the each From URI Group.
User must have the statistics:read
capability to perform this action.
{- "2": [
- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
}
Get a list of statistics associated with a specific From URI Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full From URI Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific uri group. |
[- {
- "mibName": "ipcssipcTotalActiveRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.9.0",
- "displayName": "Active Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTCPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.11.0",
- "displayName": "Active TCP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveUDPRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.12.0",
- "displayName": "Active UDP Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveTLSRegistrations",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.13.0",
- "displayName": "Active TLS Registrations",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.10.0",
- "displayName": "Total Active Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcTotalActiveSRTPCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.14.0",
- "displayName": "Active SRTP Calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSubscription",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.26.0",
- "displayName": "Active Subscriptions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveVideoCalls",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.27.0",
- "displayName": "Active Video calls",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTransferSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.28.0",
- "displayName": "Active Transfer sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveSharedControlSessions",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.29.0",
- "displayName": "Active Shared Control sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTranscodingSessions",
- "displayName": "Active Transcoding Sessions",
- "value": 0
}, - {
- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
]
Get a specific counter from a From URI Group based on its identifier.
Note: This API endpoint is provided as a convenience and simply applies a filter to the full From URI Group counter list before returning the response. If two or more counters are needed, it is recommended to fetch the full list and perform filtering on the client side.
User must have the statistics:read
capability to perform this action.
id required | integer <int32> The id used to identify the specific uri group. |
mibNameOrOid required | string A |
{- "mibName": "ipcssipcActiveTurnSession",
- "oid": ".1.3.6.1.4.1.6889.2.77.1.3.1.30.0",
- "displayName": "ipcssipcActiveTurnSession",
- "value": 0
}
(Note: This feature is currently restricted to Microsoft Teams calls only.)
These APIs are available to access the raw telemetry data for calls made via Microsoft Teams to comply with reporting requirements enforced by Microsoft. The data provided is 90% of what is required, but because certain values must be averaged and counted a certain way, the remaining 10% needs to be calculated by the user before submitting the requested data to Microsoft.
The reason why this data is not automatically summarized is because a partner and/or customer can be configured on more than one SBC, on an HA pair, or on a completely separate EMS. Because the data is stored per device, this means that the data needs to be collected from every device involved, some of which may not be able to communicate with each other.
As it stands currently, the APIs will provide the following information:
TEAMS
)To get the rest of the requisite data:
For convenience, we have provided a sample script that can connect to any number of SBCs to help gather some of this data.
Get all of the telemetry data.
User must have the telemetry:read
capability to perform this action.Wa
collapse | boolean Default: false Optionally collapse each individual entry into a single entry. |
startDate | string Example: startDate=2023-12-15T17:44:38Z Optionally only include entries after the provided ISO-8601 formatted Instant. |
endDate | string Example: endDate=2024-03-15T17:44:38Z Optionally only include entries before the provided ISO-8601 formatted Instant. |
{- "usageData": [
- {
- "summaryDate": "string",
- "nodeId": 0,
- "partnerId": "string",
- "customerId": "string",
- "callType": "TEAMS",
- "startDate": "string",
- "endDate": "string",
- "inboundData": {
- "callCount": 0,
- "totalDurationInMinutes": 0
}, - "outboundData": {
- "callCount": 0,
- "totalDurationInMinutes": 0
}, - "userUriList": [
- "string"
]
}
], - "performanceData": [
- {
- "summaryDate": "string",
- "nodeId": 0,
- "partnerId": "string",
- "customerId": "string",
- "callType": "TEAMS",
- "startDate": "string",
- "endDate": "string",
- "joinData": {
- "totalCallCount": 0,
- "successCount": 0,
- "failures": [
- {
- "reasonCode": 0,
- "count": 0
}
]
}, - "transferData": {
- "totalCallCount": 0,
- "successCount": 0,
- "failures": [
- {
- "reasonCode": 0,
- "count": 0
}
]
}
}
]
}
Get all of the telemetry usage data.
User must have the telemetry:read
capability to perform this action.
collapse | boolean Default: false Optionally collapse each individual entry into a single entry. |
startDate | string Example: startDate=2023-12-15T17:44:38Z Optionally only include entries after the provided ISO-8601 formatted Instant. |
endDate | string Example: endDate=2024-03-15T17:44:38Z Optionally only include entries before the provided ISO-8601 formatted Instant. |
[- {
- "summaryDate": "string",
- "nodeId": 0,
- "partnerId": "string",
- "customerId": "string",
- "callType": "TEAMS",
- "startDate": "string",
- "endDate": "string",
- "inboundData": {
- "callCount": 0,
- "totalDurationInMinutes": 0
}, - "outboundData": {
- "callCount": 0,
- "totalDurationInMinutes": 0
}, - "userUriList": [
- "string"
]
}
]
Get all of the telemetry performance data.
User must have the statistics:read
capability to perform this action.
collapse | boolean Default: false Optionally collapse each individual entry into a single entry. |
startDate | string Example: startDate=2023-12-15T17:44:38Z Optionally only include entries after the provided ISO-8601 formatted Instant. |
endDate | string Example: endDate=2024-03-15T17:44:38Z Optionally only include entries before the provided ISO-8601 formatted Instant. |
[- {
- "summaryDate": "string",
- "nodeId": 0,
- "partnerId": "string",
- "customerId": "string",
- "callType": "TEAMS",
- "startDate": "string",
- "endDate": "string",
- "joinData": {
- "totalCallCount": 0,
- "successCount": 0,
- "failures": [
- {
- "reasonCode": 0,
- "count": 0
}
]
}, - "transferData": {
- "totalCallCount": 0,
- "successCount": 0,
- "failures": [
- {
- "reasonCode": 0,
- "count": 0
}
]
}
}
]