Wi-Fi Calling Traffic
2 operations. Call any of them with omada_call_operation (or, in full tool mode, as a tool named by its operationId).
| Operation | Method | Summary |
|---|---|---|
| exportBatchFullChannelDetectResultData | GET | Export wi-fi calling traffic summary |
| getGridWifiCallingTrafficResult | GET | Get Wi-Fi Calling Summary |
exportBatchFullChannelDetectResultData
GET /openapi/v1/{omadacId}/files/sites/{siteId}/wifi-calling/summary/{format}
Export wi-fi calling traffic summary
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
omadacId | path | string | auto | Omada ID (filled in automatically) |
siteId | path | string | yes | Site ID (site ID or site name) |
format | path | string | yes | export data format |
timeStart | query | integer | yes | Filter query parameters, support field time range: start timestamp (second). |
timeEnd | query | integer | yes | Filter query parameters, support field time range: end timestamp (second). |
searchKey | query | string | no | Fuzzy query parameters, support field clientName,clientMac,ip,ssid,domain |
// omada_call_operation
{
"operationId": "exportBatchFullChannelDetectResultData",
"params": {
"siteId": "<siteId>",
"format": "<format>",
"timeStart": "<timeStart>",
"timeEnd": "<timeEnd>"
}
}Details, permissions and error codes
Export wi-fi calling traffic summary.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only
The possible error code for the interface in the returned body is one of the following error codes (non generic error codes):
-1001 - Invalid request parameters.
getGridWifiCallingTrafficResult
GET /openapi/v1/{omadacId}/sites/{siteId}/profiles/wifi-calling/grid/summary
Get Wi-Fi Calling Summary
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
omadacId | path | string | auto | Omada ID (filled in automatically) |
siteId | path | string | yes | Site ID (site ID or site name) |
topK | query | integer | no | Get the top-k SSIDs or EPDGs based on voice call traffic statistics. Parameter [topK] should not be null when parameter [queryTopEPDG] or parameter [queryTopEPDG] is true. |
queryTopSsid | query | boolean | yes | Whether to query top k ssids by traffic. |
queryTopEPDG | query | boolean | yes | Whether to query top k ePDGs by traffic. |
queryClients | query | boolean | yes | Whether to query client history. |
queryClientsByMac | query | boolean | yes | Whether to query client history by client MAC. |
page | query | integer | no | (default 1) |
pageSize | query | integer | no | Number of entries per page. It should be within the range of 1–1000. (default 100) |
sorts.apName | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.carrierName | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.wifiCallingProfileName | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.clientName | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.ip | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.domain | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.trafficDown | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.trafficUp | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.totalTraffic | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.clientMac | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.priority | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.ssid | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.startTime | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
sorts.endTime | query | string | no | Sort parameter may be one of asc or desc. Optional parameter. If it is not carried, it means it is not sorted by this field. When there are more than one, the first one takes effect |
filters.timeStart | query | integer | yes | Filter query parameters, support field time range: start timestamp (second). |
filters.timeEnd | query | integer | yes | Filter query parameters, support field time range: end timestamp (second). |
searchKey | query | string | no | Fuzzy query parameters, support field clientName,clientMac,ip,ssid,domain |
// omada_call_operation
{
"operationId": "getGridWifiCallingTrafficResult",
"params": {
"siteId": "<siteId>",
"queryTopSsid": "<queryTopSsid>",
"queryTopEPDG": "<queryTopEPDG>",
"queryClients": "<queryClients>",
"queryClientsByMac": "<queryClientsByMac>",
"filters.timeStart": "<filters.timeStart>",
"filters.timeEnd": "<filters.timeEnd>"
}
}Details, permissions and error codes
Get Wi-Fi Calling Summary.
The interface requires one of the permissions:
Site Settings Manager View Only
Device Config Page View Only