{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"EviSMS API","description":"Integration and usage documentation.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"evisms-api","__idx":0},"children":["EviSMS API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The EviSMS API lets you submit certified SMS and RCS messages and query the status of previously submitted messages. It is a REST API that uses HTTP Basic authentication and returns JSON responses."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"environments","__idx":1},"children":["Environments"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Environment"},"children":["Environment"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Base URL"},"children":["Base URL"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Production"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.evicertia.com"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Pre-production / QA"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://api.ecertia.com"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the public Namirial Notify API environments, this V1 service is exposed under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path. Use public routes such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviSms/Submit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1/EviSms/Query"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Some lower-level technical artifacts may show these V1 routes without the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," prefix. For customer integrations, use the public ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path shown in this documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For shared environment guidance across services, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation#environments"},"children":["API documentation"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"authentication","__idx":2},"children":["Authentication"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All endpoints require ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Basic authentication"]},". Pass your Namirial Notify credentials as the username and password in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"Authorization: Basic <base64(username:password)>\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For credential handling, callback hardening, and production security checks, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"idempotency","__idx":3},"children":["Idempotency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviSMS Submit supports idempotent submission. Include the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," header with a unique value per logical operation (a UUID is recommended)."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If the same token is submitted again after the original request completed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},", the server returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," with the original response body — the message is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," resubmitted."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following response codes are ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," cached and will re-execute the request regardless of token: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["408"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["429"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["5xx"]}," responses."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"error-responses","__idx":4},"children":["Error responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviSMS v1 uses a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object for error responses."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"responseStatus\": {\n    \"errorCode\": \"ArgumentException\",\n    \"message\": \"Text is required and cannot be empty.\",\n    \"errors\": [\n      {\n        \"errorCode\": \"NotEmpty\",\n        \"fieldName\": \"Text\",\n        \"message\": \"Text is required and cannot be empty.\"\n      }\n    ]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Machine-readable error classifier"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Human-readable summary of the error"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Array of field-level validation errors (present on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400"]}," responses)"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common status codes and their causes:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Status"},"children":["Status"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Typical cause"},"children":["Typical cause"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing required field, invalid phone number format, or invalid field value"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Incorrect credentials or missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account not provisioned for EviSMS"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For shared error handling guidance, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":5},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"submit-a-certified-sms","__idx":6},"children":["Submit a certified SMS"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviSms/Submit\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submits a new certified SMS or RCS message. On success, returns an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]}," that uniquely identifies the submitted message and can be used to query its status later."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Required fields:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient"]}," (with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PhoneNumber"]},")."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Optional fields include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]},". All fields within ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," — including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]}," — are optional. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient.LegalName"]}," is also optional."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message accepted. Body contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"eviId\": \"...\" }"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returned when an idempotent replay matches a previously ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission. The original response body is returned unchanged. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#idempotency"},"children":["Idempotency"]}," above."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request. The OpenAPI specification defines a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus"]}," object with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errorCode"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["message"]},", and optional ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["errors"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The authenticated account lacks the required API permission for EviSMS."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"POST /v1/EviSms/Submit HTTP/1.1\nAuthorization: Basic <base64(username:password)>\nContent-Type: application/json\nX-Evi-IdempotencyToken: 550e8400-e29b-41d4-a716-446655440001\n\n{\n  \"LookupKey\": \"NOTIFICATION-67890\",\n  \"Text\": \"You have a pending certified notification. Please confirm receipt.\",\n  \"IssuerName\": \"Acme Corp\",\n  \"Recipient\": {\n    \"LegalName\": \"Alice Martin\",\n    \"PhoneNumber\": \"+34612345678\"\n  },\n  \"Options\": {\n    \"CertificationLevel\": \"Advanced_EU\",\n    \"TimeToLive\": 1440,\n    \"DeliveryChannels\": [\"SMS\"],\n    \"PushNotificationUrl\": \"https://your-endpoint.example.com/callbacks/evisms\",\n    \"PushNotificationFilter\": [\"Delivered\", \"Closed\", \"AffidavitPublished\"],\n    \"AffidavitKinds\": [\"Submitted\", \"TransmissionResult\", \"DeliveryResult\", \"Closed\"]\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example response (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]},"):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"eviId\": \"87ffa214-e773-4bd5-9b8d-a8ef00fd80f8\"\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-certified-sms-messages","__idx":7},"children":["Query certified SMS messages"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviSms/Query\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns a list of certified SMS messages matching the specified filters. Results are paginated using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query parameters:"]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Parameter"},"children":["Parameter"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithUniqueIds"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by one or more unique IDs (comma-separated)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLookupKeys"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by one or more lookup keys (comma-separated)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLinkedId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string (UUID)"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by linked ID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnState"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by current state."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithOutcome"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Filter by outcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OrderResultsBy"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Sort field for results. Supported value: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreationDate"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Maximum number of results to return."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Offset"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Number of results to skip."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavits"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Include affidavit metadata in results."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"totalMatches\": N, \"results\": [...] }"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," is omitted, the API uses a default of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},". The default becomes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]}," when the request includes affidavit metadata."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"batch-operations","__idx":8},"children":["Batch operations"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Batch operations let you send the same certified SMS to many recipients as a single managed job."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::note Base path"," ","The batch endpoints are part of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["v2"]}," API and live under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v2/EviSms/Batches"]}," base path — not under the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/v1"]}," base path used by the rest of the EviSMS API."," ",":::"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The typical workflow is:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create"]}," an empty batch with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]}," — you receive a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configure"]}," the message and options (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH .../{BatchId}"]},") — the SMS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]},", certification level, callbacks, scheduling, and so on. EviSMS has no separate body or attachment endpoints; the message content is the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]}," field."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add recipients"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST .../Recipients"]},") — uploaded as a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," file."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Start processing"]}," by setting the batch ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}," (via ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PATCH"]},") once the batch is ready."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Poll ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET .../{BatchId}"]}," to follow progress (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FailedCount"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ProgressPercentage"]},"). Batch lifecycle states are ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Draft"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Scheduled"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processing"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Invalid"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::note HTTP QUERY method"," ","The two list endpoints (",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query batches"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query batch recipients"]},") are implemented with the HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," method and accept their filters in a JSON request body. Because OpenAPI cannot express the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," method, they are documented as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," with the filter fields shown as query parameters. In practice, send the request with the HTTP ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["QUERY"]}," verb and the fields in a JSON body."," ",":::"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-an-sms-batch","__idx":9},"children":["Create an SMS batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v2/EviSms/Batches\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Creates a new, empty batch. Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]}," is required; the message text, recipients, and options are set with the subsequent batch endpoints."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Required. Human-readable batch description (max 255 chars)."]}]}]}]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"BatchId\": \"<uuid>\" }"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-sms-batches","__idx":10},"children":["Query SMS batches"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"QUERY /v2/EviSms/Batches\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists SMS batches owned by the caller (or the caller's site), with cursor pagination. Filters are sent in a JSON request body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["States"]}," (array), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cursor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," (required, 1–100), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortBy"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LastUpdated"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledFor"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["StartedOn"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortOrder"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ascending"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Descending"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Direction"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Forward"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Backward"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TextSearch"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"Cursor\": \"...\", \"HasMoreResults\": bool, \"Results\": [...] }"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"get-an-sms-batch","__idx":11},"children":["Get an SMS batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v2/EviSms/Batches/{BatchId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieves the full state of a batch, including its configured message template (nested ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EviSms"]},") and processing progress."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the full batch object."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," is missing or a default (empty) UUID."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"update-an-sms-batch","__idx":12},"children":["Update an SMS batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"PATCH /v2/EviSms/Batches/{BatchId}\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Updates batch metadata and the message template options, including the SMS ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]},". All fields are optional; only the fields supplied are changed. Setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}," transitions the batch; setting ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledDate"]}," schedules it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request body (all fields optional):"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ScheduledDate"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Description"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CostCentre"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitLanguage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnlineRetentionPeriod"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LtaStorage"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAppearance"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchPushNotificationUrl"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OwnerNotificationTemplate"]},"."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch updated."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Invalid request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-an-sms-batch","__idx":13},"children":["Delete an SMS batch"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviSms/Batches/{BatchId}\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Batch deleted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-batch-recipients","__idx":14},"children":["Add batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v2/EviSms/Batches/{BatchId}/Recipients\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Adds recipients by uploading a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]}," file (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type: text/csv"]},"). The CSV uses ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[";"]}," as the column separator."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Mandatory columns:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["phonenumber"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["legalname"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Optional columns:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["lookupkey"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["evidenceaccesscontrolchallenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["evidenceaccesscontrolchallengeresponse"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Custom fields:"]}," add extra columns prefixed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*"]}," (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["*orderid"]},"); they are surfaced per recipient as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExtraFields"]},"."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Example request body:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"phonenumber;legalname;lookupkey;*orderid\n+34600000000;Acme Corp;SMS-001;ORD-001\n+34600000001;Beta Ltd;SMS-002;ORD-002\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipients accepted. No response body is returned."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The payload is empty or the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Content-Type"]}," is not ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["text/csv"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["409 Conflict"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The recipient list failed validation (for example, missing mandatory columns)."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"query-batch-recipients","__idx":15},"children":["Query batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"QUERY /v2/EviSms/Batches/{BatchId}/Recipients\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Lists the recipients of a batch, with cursor pagination. Filters are sent in a JSON request body: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Cursor"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," (1–1000), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SortDirection"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ascending"]},"/",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Descending"]},")."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"Cursor\": \"...\", \"Results\": [...] }"]},". Each result includes the recipient fields and, once processed, the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceUniqueId"]}," of the generated SMS."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Malformed request."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-all-batch-recipients","__idx":16},"children":["Delete all batch recipients"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"DELETE /v2/EviSms/Batches/{BatchId}/Recipients\n"},"children":[]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Response"},"children":["Response"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204 No Content"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipients removed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Authentication failed."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404 Not Found"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No batch with the given ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["BatchId"]}," was found."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states-and-outcomes","__idx":17},"children":["States and outcomes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For a cross-service explanation of lifecycle terminology, see ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes"},"children":["States and outcomes"]},". For a visual lifecycle reference, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes#evisms-evidence-lifecycle"},"children":["EviSMS evidence lifecycle"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["States"]}," represent the current step in the message lifecycle."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"State"},"children":["State"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Draft"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message is being prepared."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message has been accepted by the platform."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message is ready for dispatch."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The system has completed local processing; the message is ready to be sent to the telecommunications operator."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The SMS or RCS operator accepted the message for routing."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message was delivered to the recipient's device."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient opened the message (RCS only, where supported)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message lifecycle is complete."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A recoverable processing or delivery failure occurred. The platform may retry or advance to a later state."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Outcomes"]}," represent the overall result of the certification process."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Outcome"},"children":["Outcome"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["None"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No outcome determined yet."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Certified"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message certified with the configured certification level."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message was sent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message was delivered."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient opened the message (RCS only, where supported)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery failed permanently."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-request-fields","__idx":18},"children":["Key request fields"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"issuername","__idx":19},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The legal name or short identifier for the sending organisation, recorded in the certification evidence. This is not the sender shown in the recipient's inbox — that sender is configured at the account level, separately from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"certificationlevel","__idx":20},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Defines the legal framework and geographic variant for certification. The API accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced"]},", and regional values such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_EU"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_CO"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_MX"]},". Availability depends on the account."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"deliverychannels","__idx":21},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array specifying the delivery channels to use. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RCS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},". When both are specified, Namirial Notify attempts delivery in priority order."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"timetolive","__idx":22},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The time in minutes during which the platform will attempt delivery before the message expires."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"pushnotificationfilter","__idx":23},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An array of state names that trigger a callback to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},". Valid values for EviSMS: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," is not a lifecycle state — it is a platform meta-event that fires when affidavit generation for this message completes."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"affidavitkinds","__idx":24},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The set of evidence events for which affidavits should be generated. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SubmittedAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmissionResult"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryResult"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ClosedAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Complete"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CompleteAdvanced"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Event"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"evidenceaccesscontrolmethod","__idx":25},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Controls how recipients access the evidence record. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Public"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AutoChallenge"]},". When omitted, the account's configured default method applies."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]}," requires the corresponding ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallenge"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlChallengeResponse"]}," fields to be present. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AutoChallenge"]}," uses a platform-generated challenge based on known recipient data and does not require those fields."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"openapi-specification","__idx":26},"children":["OpenAPI specification"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI 3.0.3 specification for the EviSMS API provides a machine-readable definition of the service endpoints, request and response schemas, authentication method, and error responses."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Covered in the specification:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Submit endpoint"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /v1/EviSms/Submit"]},") — request and response schemas for SMS and RCS submissions, validation rules, and HTTP status codes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query endpoint"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v1/EviSms/Query"]},") — pagination parameters, filtering options, state and outcome enums, and result structure"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authentication"]}," — HTTP Basic authentication requirements"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Error handling"]}," — error response structure with error codes and diagnostic information"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data types"]}," — schema definitions for documented messages, recipients, delivery channels, and affidavits"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The OpenAPI spec can be used to generate client libraries, integration tests, or interactive API documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/oas/evisms-api"},"children":["View OpenAPI spec →"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":27},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evisms"},"children":["EviSMS"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evimail-api"},"children":["EviMail API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evinotice-api"},"children":["EviNotice API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evipost-api"},"children":["EviPost API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/api-documentation"},"children":["API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/callbacks"},"children":["Callbacks and webhooks"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/error-handling"},"children":["Error handling"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/integration-patterns"},"children":["Integration workflows"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/dev/security-best-practices"},"children":["Security and authentication"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/states-outcomes"},"children":["States and outcomes"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/user-guides/evidences-affidavits"},"children":["Evidence and affidavits"]}]}]}]},"headings":[{"value":"EviSMS API","id":"evisms-api","depth":1},{"value":"Environments","id":"environments","depth":2},{"value":"Authentication","id":"authentication","depth":2},{"value":"Idempotency","id":"idempotency","depth":2},{"value":"Error responses","id":"error-responses","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Submit a certified SMS","id":"submit-a-certified-sms","depth":3},{"value":"Query certified SMS messages","id":"query-certified-sms-messages","depth":3},{"value":"Batch operations","id":"batch-operations","depth":2},{"value":"Create an SMS batch","id":"create-an-sms-batch","depth":3},{"value":"Query SMS batches","id":"query-sms-batches","depth":3},{"value":"Get an SMS batch","id":"get-an-sms-batch","depth":3},{"value":"Update an SMS batch","id":"update-an-sms-batch","depth":3},{"value":"Delete an SMS batch","id":"delete-an-sms-batch","depth":3},{"value":"Add batch recipients","id":"add-batch-recipients","depth":3},{"value":"Query batch recipients","id":"query-batch-recipients","depth":3},{"value":"Delete all batch recipients","id":"delete-all-batch-recipients","depth":3},{"value":"States and outcomes","id":"states-and-outcomes","depth":2},{"value":"Key request fields","id":"key-request-fields","depth":2},{"value":"IssuerName","id":"issuername","depth":3},{"value":"CertificationLevel","id":"certificationlevel","depth":3},{"value":"DeliveryChannels","id":"deliverychannels","depth":3},{"value":"TimeToLive","id":"timetolive","depth":3},{"value":"PushNotificationFilter","id":"pushnotificationfilter","depth":3},{"value":"AffidavitKinds","id":"affidavitkinds","depth":3},{"value":"EvidenceAccessControlMethod","id":"evidenceaccesscontrolmethod","depth":3},{"value":"OpenAPI specification","id":"openapi-specification","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"EviSMS API","description":"REST API reference for EviSMS — submit and query certified SMS and RCS messages through Namirial Notify.","layout":"doc","outline":"deep","keywords":["evisms api","certified sms api","certified rcs api","sms submit","sms query","namirial notify api","rest api"],"seo":{"title":"EviSMS API"}},"lastModified":"2026-08-03T09:35:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/apis/evisms-api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}