# Get an SMS batch

Retrieves the full state of a batch, including its configured message template and processing progress.

Endpoint: GET /v2/EviSms/Batches/{BatchId}
Version: 1.0
Security: basicAuth

## Path parameters:

  - `BatchId` (string, required)

## Response 200 fields (application/json):

  - `Id` (string)

  - `State` (string)
    Enum: "Draft", "Submitted", "Scheduled", "Processing", "Processed", "Invalid", "Failed"

  - `Submitter` (string)

  - `SubmitterId` (string)

  - `SiteName` (string)

  - `SiteId` (string)

  - `Description` (string)

  - `CreationDate` (string)

  - `ScheduledFor` (string)
    Scheduled execution date and time in UTC.

  - `StartedOn` (string)

  - `ProcessedOn` (string)

  - `SubmittedOn` (string)

  - `InvalidOn` (string)

  - `LastUpdated` (string)

  - `TotalCount` (integer)

  - `EviSms` (object)
    The message template configured for the batch (the per-message settings applied to every recipient).

  - `EviSms.Text` (string)
    The SMS message content.

  - `EviSms.IssuerName` (string)

  - `EviSms.CostCentre` (string)

  - `EviSms.TimeToLive` (integer)

  - `EviSms.CertificationLevel` (string)
    Supported values include Standard, Advanced, and their regional variants, such as Standard_EU or Advanced_EU. Availability depends on the account.
    Enum: "Standard", "Advanced", "Standard_CO", "Standard_CR", "Standard_EC", "Standard_EU", "Standard_MX", "Standard_PE", "Advanced_CO", "Advanced_CR", "Advanced_EC", "Advanced_EU", "Advanced_MX", "Advanced_PE"

  - `EviSms.LtaStorage` (boolean)
    Enables post-close LTA storage for every message generated from the batch. Each message is stored after its own tracking reaches Closed. Requires LTA to be enabled for the site.

  - `EviSms.AffidavitKinds` (array)
    Enum: "Submitted", "SubmittedAdvanced", "TransmissionResult", "DeliveryResult", "Read", "Closed", "ClosedAdvanced", "Complete", "CompleteAdvanced", "Event"

  - `EviSms.Language` (string)

  - `EviSms.AffidavitLanguage` (string)

  - `EviSms.OnlineRetentionPeriod` (integer)

  - `EviSms.PushNotificationUrl` (string)

  - `EviSms.PushNotificationFilter` (array)
    Enum: "Ready", "Sent", "Dispatched", "Delivered", "Read", "Closed", "Failed", "AffidavitPublished"

  - `EviSms.PushNotificationExtraData` (string)

  - `EviSms.DeliveryAppearance` (string)
    Enum: "Certified", "AsIs"

  - `EviSms.OwnerNotificationTemplate` (string)

  - `BatchPushNotificationUrl` (string)

  - `SentCount` (integer)

  - `FailedCount` (integer)

  - `ProgressPercentage` (number)

  - `ExtraFields` (array)

  - `InvalidReason` (string)

  - `CsvId` (string)

  - `Outcome` (string)


## Response 400 fields

## Response 401 fields

## Response 404 fields