TextMessageBatchItem

One recipient in a batch: its one durable ID and its live delivery status.

text_message_id exists from the moment the batch is accepted and never changes. Read the message through GET /v1/text-messages/{text_message_id} at any point in its life — while it waits in the pipeline it reads queued; afterwards the same read carries its delivery outcome, failure reason, and charge.

  • created_at
    Type: stringFormat: date-time
    required

    When Resia accepted the message.

  • status
    Type: TextMessageStatusenum
    required

    Where the message is in its life right now.

    values
    acceptedqueuedsentdelivereddelivery_unconfirmedfailedcanceled
  • text_message_id
    Type: string
    min length:  
    1
    max length:  
    512
    required

    The message's one durable identifier, assigned at submission. Read it through GET /v1/text-messages/{text_message_id} for its delivery status and charge.

  • to_phone_number
    Type: string
    required

    The number this message texts, in E.164 form.

  • client_reference
    Type: string
    min length:  
    1
    max length:  
    256    nullable

    The label sent on submission, echoed back unchanged.