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

    Interface IceRequest

    The request body of an Incoming Call Event.

    interface IceRequest {
        applicationKey?: string;
        callHeaders?: CallHeader[];
        callid?: string;
        callResourceUrl?: string;
        cli?: string;
        custom?: string;
        domain?: Domain;
        duration?: number;
        event?: "ice";
        originationType?: Domain;
        rdnis?: string;
        timestamp?: Date;
        to?: Destination;
        userRate?: VoicePrice;
        version?: number;
    }
    Index

    Properties

    applicationKey? callHeaders? callid? callResourceUrl? cli? custom? domain? duration? event? originationType? rdnis? timestamp? to? userRate? version?

    Properties

    applicationKey?: string

    The unique application key. You can find it in the Sinch dashboard.

    callHeaders?: CallHeader[]

    If the call is initiated by a Sinch SDK client, call headers are the headers specified by the caller client. Read more about call headers here.

    callid?: string

    The unique ID assigned to this call.

    callResourceUrl?: string

    The path of the API resource.

    cli?: string

    The number that will be displayed to the recipient of the call. To set your own CLI, you may use your verified number or your Dashboard virtual number and add it to the connectPSTN SVAML response to the Incoming Call Event request. It must be in E.164 format.

    custom?: string

    A string that can be used to pass custom information related to the call.

    domain?: Domain

    The domain destination of the incoming call.

    duration?: number

    The duration of the call in seconds.

    event?: "ice"

    Must have the value ice.

    originationType?: Domain

    The origination domain of the incoming call.

    rdnis?: string

    The redirected dialled number identification service.

    timestamp?: Date

    The timestamp in UTC format.

    to?: Destination

    An object containing information about the recipient of the call.

    userRate?: VoicePrice

    The rate that will be charged for the call established to the original destination. If the SVAML response specifies another destination, the same rate may not apply.

    version?: number

    The current API version.

    Settings

    Member Visibility

    On This Page

    Properties