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

    Interface ApiUpdateBinaryMtMessage

    interface ApiUpdateBinaryMtMessage {
        body?: string;
        callback_url?: string;
        client_reference?: string;
        delivery_report?: string;
        expire_at?: Date;
        feedback_enabled?: boolean;
        from?: string;
        from_npi?: number;
        from_ton?: number;
        send_at?: Date;
        to_add?: string[];
        to_remove?: string[];
        type?: "mt_binary";
        udh?: string;
    }
    Index

    Properties

    body? callback_url? client_reference? delivery_report? expire_at? feedback_enabled? from? from_npi? from_ton? send_at? to_add? to_remove? type? udh?

    Properties

    Optionalbody

    body?: string

    The message content Base64 encoded. Max 140 bytes together with udh.

    callback_url?: string

    Override the default callback URL for this batch. Constraints: Must be valid URL.

    client_reference?: string

    The client identifier of a batch message. If set, the identifier will be added in the delivery report/callback of this batch.

    delivery_report?: string

    Request delivery report callback. Note that delivery reports can be fetched from the API regardless of this setting.

    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. For example: YYYY-MM-DDThh:mm:ss.SSSZ.

    feedback_enabled?: boolean

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

    from?: string

    Sender number. Must be valid phone number, short code or alphanumeric.

    from_npi?: number

    Number Plan Indicator for the sender number. Use to override the automatic detection.

    from_ton?: number

    The type of number for the sender number. Use to override the automatic detection.

    send_at?: Date

    If set, in the future the message will be delayed until send_at occurs. Formatted as ISO-8601: YYYY-MM-DDThh:mm:ss.SSSZ. Constraints: Must be before expire_at. If set in the past, messages will be sent immediately.

    to_add?: string[]

    List of phone numbers and group IDs to add to the batch.

    to_remove?: string[]

    List of phone numbers and group IDs to remove from the batch.

    type?: "mt_binary"

    SMS in binary format.

    udh?: string

    The UDH header of a binary message HEX encoded. Max 140 bytes together with body.

    Settings

    Member Visibility

    On This Page

    Properties