TextMessageBatchSummary

A whole batch's progress in one read.

Returned by the poll and the batch list. completed_at is set once the batch reaches a terminal status; it is null while the batch is still in progress.

  • counts
    Type: TextMessageBatchCounts
    required

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

    Properties: 6
  • created_at
    Type: stringFormat: date-time
    required

    When Resia accepted the batch.

  • from_phone_number
    Type: string
    required

    The sender number every message in the batch texts from.

  • id
    Type: string
    min length:  
    1
    max length:  
    512
    required

    Identifier of the batch.

  • status
    Type: BatchStatusenum
    required

    The batch's derived lifecycle state.

    values
    in_progresscompletedcanceled
  • total
    Type: integer
    min:  
    0
    required

    How many recipients the batch created. Equal to the submitted count minus the rejected entries; zero when every recipient was rejected.

  • completed_at
    Type: stringFormat: date-timenullable

    When the batch reached a terminal state, or null while it is still in progress.