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

    Interface BinaryResponse

    interface BinaryResponse {
        body?: string;
        callback_url?: string;
        canceled?: boolean;
        client_reference?: string;
        created_at?: Date;
        delivery_report?: string;
        expire_at?: Date;
        feedback_enabled?: boolean;
        from?: string;
        from_npi?: number;
        from_ton?: number;
        id?: string;
        modified_at?: Date;
        send_at?: Date;
        to?: string[];
        type?: "mt_binary";
        udh?: string;
    }
    Index

    Properties

    body? callback_url? canceled? client_reference? created_at? delivery_report? expire_at? feedback_enabled? from? from_npi? from_ton? id? modified_at? send_at? to? type? udh?

    Properties

    Optionalbody

    body?: string

    The message content provided. Base64 encoded.

    callback_url?: string

    The callback URL provided in the request.

    canceled?: boolean

    Indicates whether or not the batch has been canceled.

    client_reference?: string

    The string input to identify this batch message. If set, the identifier will be added in the delivery report/callback of this batch.

    created_at?: Date

    Timestamp for when batch was created. Formatted as ISO-8601. For example: YYYY-MM-DDThh:mm:ss.SSSZ.

    delivery_report?: string

    The delivery report callback option selected. Will be either none, summary, full, per_recipient, or per_recipient_final.

    expire_at?: Date

    If set, the system will stop trying to deliver the message at this point. Must be after send_at. Default and max is 3 days after send_at. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ.

    feedback_enabled?: boolean

    If set to true then feedback is expected after successful delivery.

    from?: string

    The sender number provided. Required if the Automatic Default Originator is not configured.

    from_npi?: number

    Number Plan Indicator for the sender number.

    from_ton?: number

    The type of number for the sender number.

    id?: string

    Unique identifier for batch.

    modified_at?: Date

    Timestamp for when batch was last updated. Formatted as ISO-8601. For example: YYYY-MM-DDThh:mm:ss.SSSZ.

    send_at?: Date

    If set, the date and time the message should be delivered. Formatted as ISO-8601. For example: YYYY-MM-DDThh:mm:ss.SSSZ.

    to?: string[]

    A list of phone numbers and group IDs that have received the batch. More info.

    type?: "mt_binary"

    SMS in binary format.

    udh?: string

    The UDH header of a binary message HEX encoded. Max 140 bytes including the body.

    Settings

    Member Visibility

    On This Page

    Properties