# EviSMS

Certified SMS and RCS submission, status tracking, and evidence retrieval via v1, plus SMS batch delivery and recipients via v2.

## Submit a certified SMS

 - [POST /v1/EviSms/Submit](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismssubmit.md)

## Query certified SMS messages (GET)

 - [GET /v1/EviSms/Query](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsqueryget.md)

## Create an SMS batch

 - [POST /v2/EviSms/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchcreate.md): Creates a new, empty SMS batch. Only a Description is required at creation; the message text, recipients, and options are set with the subsequent batch endpoints. Returns the BatchId used by all other batch operations.

## Query SMS batches (HTTP QUERY method)

 - [GET /v2/EviSms/Batches](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchesquery.md): Lists SMS batches owned by the caller (or the caller's site), with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields in a JSON body (States, Cursor, Limit, SortBy, SortOrder, Direction, TextSearch).

## Get an SMS batch

 - [GET /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchget.md): Retrieves the full state of a batch, including its configured message template and processing progress.

## Update an SMS batch

 - [PATCH /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchpatch.md): Updates batch metadata and the message template options, including the SMS Text. All fields are optional; only the fields supplied are changed. Setting State transitions the batch (for example, to start processing). Setting ScheduledDate schedules the batch. Batch scheduling uses UTC. Specify ScheduledDate in UTC.

## Delete an SMS batch

 - [DELETE /v2/EviSms/Batches/{BatchId}](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchdelete.md): Removes a previously created batch.

## Add batch recipients (CSV)

 - [POST /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientspost.md): Adds recipients to the batch by uploading a text/csv file. The CSV uses ; as the column separator. Mandatory columns: phonenumber, legalname. Optional columns: lookupkey, evidenceaccesscontrolchallenge, evidenceaccesscontrolchallengeresponse. Custom per-recipient fields are added as extra columns prefixed with  (for example, orderid).

## Query batch recipients (HTTP QUERY method)

 - [GET /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsquery.md): Lists the recipients of a batch, with cursor pagination.

This endpoint uses the HTTP QUERY method, not GET. OpenAPI cannot express the QUERY method, so it is shown here as a GET with the filter fields as query parameters. In practice, send an HTTP QUERY request with the fields (Cursor, Limit, SortDirection) in a JSON body.

## Delete all batch recipients

 - [DELETE /v2/EviSms/Batches/{BatchId}/Recipients](https://docs.namirial.app/products/namirialnotify/apis/oas/namirialnotify-api/evisms/evismsbatchrecipientsdelete.md): Removes all recipients from the batch.