GetCallsRequestDto
Filters for GET Api/Calls. Every field except pagination is optional — an absent field applies no condition.
The list unions two sources: calls, and the sessions an agent recorded without a call of their own. A filter on a column only calls have (queueIds, queueTypes, recallCreated, outcomeReason, webexCorrelationId) drops the session branch entirely, because a session cannot satisfy it.
This endpoint ignores pagination.sortBy: the union spans two id sequences, so rows are always ordered by their start time and only pagination.descending is honoured.
Backend-источник: features.callcenterservice/Features.CallCenterService/Nuget.CallCenterApiClient/Dto/Calls/Requests/GetCallsRequestDto.cs (features.callcenterservice).
Также определён в:
integration.callcenternotification.
Поля
| Поле | Тип (TS) | Обязательное | Описание | Тип (C#) |
|---|---|---|---|---|
phoneNumbers | string[] | да | Prefix match against either number of a call, or the single number of a session. Numbers are OR-ed together. callingPhoneNumber and calledPhoneNumber are the per-side forms. An empty array is indistinguishable from an absent field in a query string, so it means "no restriction" and returns every call. To show nothing for a contact without a phone number, skip the call instead of sending an empty array. | List<string>? |
from | string | null | нет | Start of the window, inclusive, as a local calendar day (YYYY-MM-DD). | DateTime? |
to | string | null | нет | End of the window, inclusive, as a local calendar day (YYYY-MM-DD). | DateTime? |
answered | boolean | null | нет | Whether the other side was reached. Read from the agent's session when there is one, otherwise from what Webex reported. | bool? |
missed | boolean | null | нет | Inverse of answered, in either direction. Kept for compatibility. | bool? |
category | CallSessionCategoryDto | null | нет | Single category. categories is the multi-select form. | — |
callDirection | CallDirectionDto | null | нет | Single direction. callDirections is the multi-select form. | — |
agentIds | number[] | нет | Matches calls and sessions handled by any of the listed agents. | — |
queueIds | number[] | нет | Matches calls routed through any of the listed queues. Sessions have no queue. | — |
queueTypes | QueueTypeDto[] | нет | Matches calls whose queue is of any of the listed types. Sessions have no queue. This replaces the singular QueueType parameter the portal used to send, which the backend never read. | — |
callDirections | CallDirectionDto[] | нет | Multi-select form of callDirection. | — |
categories | CallSessionCategoryDto[] | нет | Multi-select form of category. | — |
sessionOutcomes | SessionOutcomeDto[] | нет | How the agent judged the conversation. | — |
sessionResults | SessionResultDto[] | нет | What the agent recorded as the result of the conversation. | — |
callingPhoneNumber | string | нет | Prefix match on the originating number. A session stores one number for both sides, so it matches that number. | — |
calledPhoneNumber | string | нет | Prefix match on the dialled number. A session stores one number for both sides, so it matches that number. | — |
externalEntityTypes | CallSessionExternalEntityTypeDto[] | нет | Kind of entity the session was linked to. | — |
externalEntityId | number | null | нет | Id of the linked entity. Applies on its own, without externalEntityTypes. | — |
recallCreated | boolean | null | нет | Whether a recall was created off the call. Set only by the inbound recall worker, so it is always false on outbound calls. Sessions do not carry it. | — |
durationSeconds | PaginationRangeFilter<number> | нет | Range over the length of the conversation in seconds. Calls and sessions that never finished are excluded. | — |
createdAt | PaginationRangeFilter<string> | нет | ISO 8601 range over the creation timestamp of the record, not over when the call started. | — |
outcomeReason | string | нет | Substring match on the outcome reason Webex reported. Sessions do not carry it. | — |
comment | string | нет | Substring match on the comment the agent left on the session. | — |
webexCorrelationId | string | нет | Exact match on the Webex correlation id, for tracing a single call. Sessions do not carry it. | — |
pagination | Pagination | да | — | Pagination |
Пример
json
{
"phoneNumbers": [],
"from": "2026-05-05T08:00:00Z",
"to": "2026-05-05T08:00:00Z",
"answered": false,
"missed": false,
"category": "<callsessioncategorydto>",
"callDirection": "<calldirectiondto>",
"agentIds": [],
"queueIds": [],
"queueTypes": [],
"callDirections": [],
"categories": [],
"sessionOutcomes": [],
"sessionResults": [],
"callingPhoneNumber": "+49123456789",
"calledPhoneNumber": "+49123456789",
"externalEntityTypes": [],
"externalEntityId": 0,
"recallCreated": false,
"durationSeconds": "<PaginationRangeFilter<number>>",
"createdAt": "<PaginationRangeFilter<string>>",
"outcomeReason": "string",
"comment": "string",
"webexCorrelationId": "uuid",
"pagination": "<Pagination>"
}