@getdial/sdk - v0.38.0
    Preparing search index...

    Type Alias CapabilityState

    One capability's state. previousStatus, error and retryAvailableAt appear only on the asynchronous capabilities (call on an iMessage number, and whatsapp); a synchronous one has no transition to report and cannot fail.

    type CapabilityState = {
        error?: string | null;
        previousStatus?: CapabilityStatus | null;
        retryAvailableAt?: string | null;
        status: CapabilityStatus;
    }
    Index
    error? previousStatus? retryAvailableAt? status
    error?: string | null

    Vendor-neutral, customer-facing reason; non-null only when failed.

    previousStatus?: CapabilityStatus | null

    The status this capability left, when it just moved.

    retryAvailableAt?: string | null

    When this capability will accept another attempt, ISO-8601 — the cooldown. Non-null only on a failed capability whose cooldown is still in the future; null means retry now, or that no retry will help.

    status: CapabilityStatus

    Settings
    Member Visibility

    On This Page
    Properties