Sinch Node.js SDK - v1.6.0
    Preparing search index...

    Interface ListCallsRequestData

    interface ListCallsRequestData {
        callReason?: string;
        callResult?: string;
        callType?: string;
        endTime?: Date;
        from?: string;
        page?: number;
        pageSize?: number;
        serviceId?: string;
        startTime?: Date;
        to?: string;
    }
    Index

    Properties

    callReason?: string

    Filter results to only include calls whose callReason matches the specified value.

    If omitted, calls with any reason are included.

    callResult?: string

    Filter results to only include calls whose callResult matches the specified value.

    If omitted, calls with any result are included.

    callType?: string

    Only include calls of the specified type.

    If omitted, calls of all types are included.

    endTime?: Date

    Only include calls that ended before endTime (exclusive).

    Use a more precise timestamp to narrow the results. For example:

    • 2025-03-01 matches calls ending up to 2025-03-01T00:00:00Z
    • 2025-03-01T14:00:00Z matches calls ending up to 14:00:00Z on 2025-03-01
    from?: string

    Only include calls where from matches this origin. For inbound calls, this is the caller; for outbound calls, this is the calling party.

    page?: number

    Page number (1-based)

    pageSize?: number

    Number of items to be returned on each page.

    serviceId?: string

    The ID of the service.

    startTime?: Date

    Only include calls that started at or after startTime.

    Use a more precise timestamp to narrow the results. For example:

    • 2025-02-01 matches calls starting from 2025-02-01T00:00:00Z
    • 2025-02-01T14:00:00Z matches calls starting from 14:00:00Z on 2025-02-01
    to?: string

    Only include calls where to matches this destination. For inbound calls, this is the called party; for outbound calls, this is the callee/recipient.