Interface DeliveryReport

interface DeliveryReport {
    batch_id: string;
    client_reference?: string;
    statuses: MessageDeliveryStatus[];
    total_message_count: number;
    type: "delivery_report_sms" | "delivery_report_mms";
}

Properties

batch_id: string

The ID of the batch this delivery report belongs to.

client_reference?: string

The client identifier of the batch this delivery report belongs to, if set when submitting batch.

Array with status objects. Only status codes with at least one recipient will be listed.

total_message_count: number

The total number of messages in the batch.

type: "delivery_report_sms" | "delivery_report_mms"

The delivery report type.