GET v2/EviSMS/Batches/{batchid}

HTTP Method: GET

Description:

This endpoint retrieves the details of a bulk email batch previously created in the system. The batchid parameter in the URL is the unique identifier returned by the initial batch creation (Submit) endpoint. Additional query parameters allow customization of the level of detail in the response.

Output Parameters

• Id (Guid): Unique identifier for the batch.

• Submitter (text): User who generates the batch.

• SubmitterId (Guid): Identifier of the user who generates the batch.

• SiteName (text): Name of the site associated with the batch.

• SiteId (Guid): Site identifier associated with the batch.

• State (string): The current state of the bulk email (e.g., Draft, Scheduled, Sent).

• CreationDate (datetime): The creation date of the batch in UTC.

• LastUpdate (datetime): The last update time of the batch in UTC.

• Description (string): Description of the bulk email batch.

• SentCount (int): Counter of the shipments made so far.

• FailedCount (int): Counter of failed shipments so far.

• ProgessPercentage (int): Percentage of progress to date.

• Outcome (text): Final result of the shipment process.

• TotalCount (int?, optional): The total number of recipients (if IncludeRecipientsCount is true).

• Options (object, optional, if IncludeOptions is true): Configuration details for the batch, including:

  • IssuerName (string): The sender's name.

  • CostCentre (string)

  • CertificationLevel (string)

  • LtaStorage (bool)

  • AffidavidKind (array)

  • Language (string)

  • AffidavitLanguage (string)

  • OnlineRetentionPeriod (int)

  • PushNotificationUrl (string)

  • PushNotificationFilter (array)

  • PushNotificationExtraData (string)

  • HideBanners (bool)

  • BatchPushNotificationUrl (string)

Request Example

Response Example

Notes

• Batch ID:

  • The batchid in the URL must correspond to an existing batch created in the system.