@vonage/voice/dist/cjs/types/Responses/CallPageResponse.d.ts

The Voice API lets you create outbound calls, control in-progress calls and get information about historical calls.

import { APILinks } from '@vonage/server-client';
import { CallDetailResponse } from './CallDetailResponse.js';
import '../CallDetail.js';
import '../BasicCallDetail.js';
import '../../enums/CallStatus.js';
import '../CommonCallFields.js';
import '../Endpoint/CallEndpoint.js';
import '../Endpoint/PhoneEndpoint.js';
import '../Endpoint/SIPEndpoint.js';
import '../Endpoint/VBCEndpoint.js';
import '../Endpoint/WebsocketEndpoint.js';
import '../Endpoint/AppEndpoint.js';
import '../Endpoint/PSTNEndpoint.js';
import '../../enums/CallDirection.js';
import './CallEndpointResponse.js';

/**
 * Represents the response for a page of call details, including information
 * about the page itself and an array of call details.
 *
 * @remarks
 * Vonage API's will return information using `snake_case`. This represents the
 * pure response before the client will transform the keys into `camelCase`.
 */
type CallPageResponse = {
    /**
     * The total count of call details in the response.
     */
    count: number;
    /**
     * The number of call details per page.
     */
    page_size: number;
    /**
     * The index of the first call detail in the current page.
     */
    record_index: number;
    /**
     * An embedded object containing an array of call details.
     */
    _embedded: {
        /**
         * An array of call details.
         */
        calls: Array<CallDetailResponse>;
    };
} & APILinks;

export type { CallPageResponse };