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

    Interface TextResponse

    interface TextResponse {
        body?: string;
        callback_url?: string;
        canceled?: boolean;
        client_reference?: string;
        created_at?: Date;
        delivery_report?: string;
        expire_at?: Date;
        feedback_enabled?: boolean;
        flash_message?: boolean;
        from?: string;
        from_npi?: number;
        from_ton?: number;
        id?: string;
        max_number_of_message_parts?: number;
        modified_at?: Date;
        parameters?: ParameterGroup;
        send_at?: Date;
        to?: string[];
        truncate_concat?: boolean;
        type?: "mt_text";
    }
    Index

    Properties

    body? callback_url? canceled? client_reference? created_at? delivery_report? expire_at? feedback_enabled? flash_message? from? from_npi? from_ton? id? max_number_of_message_parts? modified_at? parameters? send_at? to? truncate_concat? type?

    Properties

    Optionalbody

    body?: string

    The message content

    callback_url?: string

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

    canceled?: boolean

    Indicates if the batch has been canceled or not.

    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

    created_at?: Date

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

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

    feedback_enabled?: boolean

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

    flash_message?: boolean

    Shows message on screen without user interaction while not saving the message to the inbox.

    from?: string

    Sender number. Must be valid phone number, short code or alphanumeric. Required if Automatic Default Originator not configured.

    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.

    id?: string

    Unique identifier for batch

    max_number_of_message_parts?: number

    Message will be dispatched only if it is not split to more parts than Max Number of Message Parts

    modified_at?: Date

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

    parameters?: ParameterGroup

    ParameterGroup

    send_at?: Date

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

    to?: string[]

    List of Phone numbers and group IDs that will receive the batch. More info

    truncate_concat?: boolean

    If set to true the message will be shortened when exceeding one part.

    type?: "mt_text"

    Regular SMS

    Settings

    Member Visibility

    On This Page

    Properties