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

    Interface MediaRequest

    Only available in the US. Contact support if you wish to send MMS.

    interface MediaRequest {
        body: MediaBody;
        callback_url?: string;
        client_reference?: string;
        delivery_report?: string;
        expire_at?: Date;
        feedback_enabled?: boolean;
        from?: string;
        parameters?: ParameterGroup;
        send_at?: Date;
        strict_validation?: boolean;
        to: string[];
        type?: "mt_media";
    }
    Index

    Properties

    body callback_url? client_reference? delivery_report? expire_at? feedback_enabled? from? parameters? send_at? strict_validation? to type?

    Properties

    body

    body: MediaBody

    MediaBody

    callback_url?: string

    Override the default callback URL for this batch. 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: 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. Required if Automatic Default Originator not configured.

    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.

    strict_validation?: boolean

    Whether or not you want the media included in your message to be checked against Sinch MMS channel best practices. If set to true, your message will be rejected if it doesn't conform to the listed recommendations, otherwise no validation will be performed.

    to: string[]

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

    type?: "mt_media"

    MMS

    Settings

    Member Visibility

    On This Page

    Properties