Versions Compared

Version Old Version 1 New Version Current
Changes made by

Jose Luis Lozano

Jose Luis Lozano

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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

Basic Request:

Code Block
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

GET /v2/EviSMS/Batches/{batchid}

...

Response Example

Code Block
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

GET /v2/EviSMS/Batches/{batchid}?IncludeOptions=true&IncludeRecipientsCount=true&IncludeAttachments=true

Response Example

Response with All Details:

Code Block
{
    "Body": "Dear {{FirstName}}, we are excited to have you onboard!{    
    "Id": "01948843-2aec-4fca-a203-9965370ad291",
    "State": "Draft",
    "SubjectSubmitter": "Welcome {{FirstName}}!desarrollo.negocio@evicertia.com",
    "ScheduledForSubmitterId": "2024-11-15T10:00:00Z00005058-3e63-42cf-aa2c-a3160034a66f",
    "StateSiteName": "Scheduledcertified-communications",
    "CreationDateSiteId": "2024-11-10T15:30:00Z426eccb1-a677-4ea7-b9fe-afe800b8f4bc",
    "Description": "Welcomecambio campaignde batchdes",
    "BatchIdCreationDate": "a5b1f3f22025-5c73-4b6d-88b9-73d81a9c5f8e01-21T09:48:10.8662960+00:00",
    "IssuerNameLastUpdated": "Marketing Team2025-01-21T09:55:58.0000000+00:00",
    "RecipientsCountTotalCount": 1500,
    "AttachmentsEviSms": [
        {
   
        "DisplayNameText": "User Guide",
   Este es el texto que quiero informar",
        "DataIssuerName": "JVBERi0xLjQKJcfs...Base64EncodedContent...JL",
   
        "FileNameCostCentre": "user_guide.pdf"
        }
    ],
    "Options": {234",
        "CostCentreTimeToLive": "Marketing"10,
        "CertificationLevel": "BasicAdvanced",
        "LtaStorage": truefalse,
        "Language": "en",
        "AffidavitLanguage": "en",
        "OnlineRetentionPeriod": 51,
        "PushNotificationUrlHideBanners": "https://client.callback.url/notifications",false
        "PushNotificationFilter": ["StatusChange", "DeliveryConfirmation"],
   },
    "CommitmentOptionsSentCount": "AcceptOrReject",
   0,
    "CommitmentCommentsAllowedFailedCount": true0,
   
    "RejectReasonsProgressPercentage": ["Content not relevant", "Incorrect recipient"],
   0,
    "AcceptReasons": ["Confirmed interest", "Interested in details"],
        "RequireRejectReasons": false,
        "RequireAcceptReasons": false,
        "HideBanners": true
    }
}

Notes

Flexible Detail Levels:

...

Use query parameters (IncludeOptions, IncludeRecipientsCount, IncludeAttachments) to control the detail level in the response.

...

Outcome": "None"
}

Notes

  • Batch ID:

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

    Efficient Retrieval:

    • Avoid setting unnecessary query parameters to reduce response size and improve performance.