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

    Interface ApiUpdateMtMessage

    interface ApiUpdateMtMessage {
        callback_url?: string;
        delivery_report?: string;
        expire_at?: Date;
        from?: string;
        send_at?: Date;
        to_add?: string[];
        to_remove?: string[];
        type?: string;
    }
    Index

    Properties

    callback_url? delivery_report? expire_at? from? send_at? to_add? to_remove? type?

    Properties

    callback_url?: string

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

    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. Constraints: Must be after send_at Default: 3 days after send_at

    from?: string

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

    send_at?: Date

    If set, in the future the message will be delayed until send_at occurs. Formatted as <a href="https://en.wikipedia.org/wiki/ISO_8601\" target="_blank">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?: string

    Settings

    Member Visibility

    On This Page

    Properties