TextMessageBatchCounts

How a batch's recipients are distributed across states right now.

Each recipient is counted once, by its message's own status. A batch message reads queued from acceptance until it is handed to a carrier, then sent → delivered, or delivery_unconfirmed or failed; canceled is a recipient stopped before its message was sent. The six counts always sum to the batch's total.

  • canceled
    Type: integer
    min:  
    0
    required

    Recipients stopped before their message was sent.

  • delivered
    Type: integer
    min:  
    0
    required

    Messages the carrier confirmed delivered.

  • delivery_unconfirmed
    Type: integer
    min:  
    0
    required

    Messages sent for which no final delivery confirmation ever arrived.

  • failed
    Type: integer
    min:  
    0
    required

    Messages that failed, including recipients refused before sending.

  • queued
    Type: integer
    min:  
    0
    required

    Recipients waiting in the pipeline, before the message is sent.

  • sent
    Type: integer
    min:  
    0
    required

    Messages handed to a carrier, not yet confirmed delivered.