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

    Interface CallbackPayloadCommon

    Shared fields for Numbers callback events (ACTIVE_NUMBER and NUMBER_ORDER).

    interface CallbackPayloadCommon {
        eventId?: string;
        failureCode?: FailureCodeEnum;
        internalFailureCode?: string;
        projectId?: string;
        resourceType?: string;
        status?: string;
        timestamp?: Date;
    }
    Index

    Properties

    eventId? failureCode? internalFailureCode? projectId? resourceType? status? timestamp?

    Properties

    eventId?: string

    The ID of the event.

    failureCode?: FailureCodeEnum

    If the status is FAILED, a failure code will be provided. For numbers provisioning to SMS platform, there won't be any extra failureCode, as the result is binary. For campaign provisioning-related failures, refer to the list for the possible values.

    Prefer CallbackPayloadActiveNumber.failureCode after narrowing on resourceType.

    internalFailureCode?: string

    If the status is FAILED, certain processes (eg. number to campaign provisioning) will have an internalFailureCode in the payload. The details of these codes can be found in our dedicated Provisioning errors documentation.

    Prefer CallbackPayloadActiveNumber.internalFailureCode after narrowing on resourceType.

    projectId?: string

    The ID of the project to which the event belongs.

    resourceType?: string

    The type of the resource.

    status?: string

    The status of the event.

    Prefer CallbackPayloadActiveNumber.status or CallbackPayloadNumberOrder.status after narrowing on resourceType.

    timestamp?: Date

    The date and time when the callback was created and added to the callbacks queue.

    Settings

    Member Visibility

    On This Page

    Properties