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

    Interface CallbackPayload

    interface CallbackPayload {
        eventId?: string;
        eventType?: CallbackPayloadEventTypeEnum;
        failureCode?: CallbackPayloadFailureCodeEnum;
        internalFailureCode?: string;
        projectId?: string;
        resourceId?: string;
        resourceType?: string;
        status?: string;
        timestamp?: Date;
    }
    Index

    Properties

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

    Properties

    eventId?: string

    The ID of the event.

    eventType?: CallbackPayloadEventTypeEnum

    The type of the event.

    failureCode?: CallbackPayloadFailureCodeEnum

    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.

    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.

    projectId?: string

    The ID of the project to which the event belongs.

    resourceId?: string

    The unique identifier of the resource, depending on the resource type. For example, a phone number, a hosting order ID, or a brand ID.

    resourceType?: string

    The type of the resource.

    status?: string

    The status of the event. For example, SUCCEEDED or FAILED.

    timestamp?: Date

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

    Settings

    Member Visibility

    On This Page

    Properties