@webitel/api-services
    Preparing search index...

    Module call-service/call-service.zod

    Variables

    AggregateHistoryCallBody

    AggregateHistoryCall performs statistical analysis on historical data. Group and aggregate metrics like average duration, call counts, or peak hours.

    AggregateHistoryCallResponse
    BlindTransferCallBody
    BlindTransferCallParams

    BlindTransferCall redirects an active call to another destination.

    BlindTransferCallResponse
    ConfirmPushParams

    ConfirmPush confirms receipt of a push notification for synchronization.

    ConfirmPushResponse
    CreateCallAnnotationBody
    CreateCallAnnotationParams

    CreateCallAnnotation adds a text note to a specific timeframe of a historical call.

    CreateCallAnnotationResponse
    CreateCallBody

    CreateCall initiates a new outbound call with specified parameters.

    CreateCallResponse
    DeleteCallAnnotationParams

    DeleteCallAnnotation removes an annotation from a historical call.

    DeleteCallAnnotationResponse
    DtmfCallBody
    DtmfCallParams

    DtmfCall sends DTMF digits to an active call.

    DtmfCallResponse
    EavesdropCallBody
    EavesdropCallParams

    EavesdropCall allows a supervisor to listen, whisper, or join an active call.

    EavesdropCallResponse
    HangupCallBody
    HangupCallParams

    HangupCall terminates an active call session.

    HangupCallResponse
    HoldCallBody
    HoldCallParams

    HoldCall puts an active call on hold.

    HoldCallResponse
    PatchHistoryCallBody
    PatchHistoryCallParams

    PatchHistoryCall updates metadata for a completed call (e.g., variables or visibility).

    PatchHistoryCallResponse
    patchHistoryCallResponseFilesItemTypeDefault
    patchHistoryCallResponseFilesJobItemActionDefault
    patchHistoryCallResponseFilesJobItemStateDefault
    ReadCallParams

    ReadCall returns detailed real-time information for a specific active call.

    ReadCallQueryParams
    ReadCallResponse
    RedialCallBody
    RedialCallParams

    RedialCall quickly initiates a new call using data from a previous history record.

    RedialCallResponse
    SearchActiveCallQueryParams

    SearchActiveCall returns a list of all calls currently in progress.

    SearchActiveCallResponse
    SearchHistoryCallPostBody

    SearchHistoryCallPost retrieves a list of completed calls using a complex filter body (POST). Ideal for large filter sets that exceed URL length limits.

    SearchHistoryCallPostResponse
    searchHistoryCallPostResponseItemsItemFilesItemTypeDefault
    searchHistoryCallPostResponseItemsItemFilesJobItemActionDefault
    searchHistoryCallPostResponseItemsItemFilesJobItemStateDefault
    SearchHistoryCallQueryParams

    SearchHistoryCall retrieves a list of completed calls using filters (GET). Supports advanced filtering by participants, duration, causes, and custom variables.

    SearchHistoryCallResponse
    searchHistoryCallResponseItemsItemFilesItemTypeDefault
    searchHistoryCallResponseItemsItemFilesJobItemActionDefault
    searchHistoryCallResponseItemsItemFilesJobItemStateDefault
    SetVariablesCallBody
    SetVariablesCallParams

    SetVariablesCall updates call channel variables in real-time.

    SetVariablesCallResponse
    UnHoldCallBody
    UnHoldCallParams

    UnHoldCall resumes a call from hold state.

    UnHoldCallResponse
    UpdateCallAnnotationBody
    UpdateCallAnnotationParams

    UpdateCallAnnotation modifies an existing call note.

    UpdateCallAnnotationResponse