{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-products/namirialnotify/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition"]},"type":"markdown"},"seo":{"title":"EviSMS","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","__idx":0},"children":["EviSMS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["EviSMS is the Namirial Notify service for sending certified mobile communications through SMS and RCS. In the standard EviSMS flow, the certified content is the message itself — delivered directly to the recipient's device, with evidence recorded for processing, sending, delivery, and where supported, reading."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::info EviSMS is a direct-message service"," ","The certified content is the message itself, delivered straight to the recipient's device. If you need hosted content, recipient authentication before reading, or formal accept/reject interactions, use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}," instead."," ",":::"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For the API reference, see the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"when-to-use-evisms","__idx":1},"children":["When to use EviSMS"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use EviSMS when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["You need certified delivery directly to a mobile device"]}," — in the standard flow, the message arrives in the recipient's SMS inbox or RCS client without requiring them to follow a link or open a hosted page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Speed and reach are priorities"]}," — SMS reaches virtually any mobile number worldwide; RCS adds richer formatting and read receipts where the operator supports it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["The communication fits within mobile message constraints"]}," — the certified content is the SMS or RCS message text itself."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail"]}," when the certified communication is an email with attachments, HTML content, or commitment workflows. Use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}," when you need controlled access to the content, recipient authentication before reading, or explicit acceptance/rejection workflows."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-evisms-works","__idx":2},"children":["How EviSMS works"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"lifecycle-overview","__idx":3},"children":["Lifecycle overview"]},{"$$mdtype":"Tag","name":"Mermaid","attributes":{"data-language":"mermaid","diagramSource":"%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#E4F2F2', 'primaryBorderColor': '#006660', 'primaryTextColor': '#0A1111', 'lineColor': '#047C76', 'secondaryColor': '#CDDBDB', 'tertiaryColor': '#f5fafa', 'edgeLabelBackground': '#f5fafa', 'transitionColor': '#047C76'}}}%%\nstateDiagram-v2\n [*] --> New : Submit accepted\n New --> Ready : Validated and certified\n Ready --> Dispatched : Queued for channel dispatch\n Dispatched --> Sent : Operator accepted message for routing\n Sent --> Delivered : Delivery confirmation received\n Delivered --> Read : Recipient opened message (RCS only)\n Delivered --> Closed : Lifecycle complete\n Read --> Closed : Lifecycle complete\n Sent --> Closed : TimeToLive elapsed\n Sent --> Failed : Recoverable delivery failure\n Failed --> Closed : Closed after failure\n","diagramHtml":"

Submit accepted

Validated and certified

Queued for channel dispatch

Operator accepted message for routing

Delivery confirmation received

Recipient opened message (RCS only)

Lifecycle complete

Lifecycle complete

TimeToLive elapsed

Recoverable delivery failure

Closed after failure

New

Ready

Dispatched

Sent

Delivered

Read

Closed

Failed

"},"children":["%%{init: {'theme': 'base', 'themeVariables': {'primaryColor': '#E4F2F2', 'primaryBorderColor': '#006660', 'primaryTextColor': '#0A1111', 'lineColor': '#047C76', 'secondaryColor': '#CDDBDB', 'tertiaryColor': '#f5fafa', 'edgeLabelBackground': '#f5fafa', 'transitionColor': '#047C76'}}}%%\nstateDiagram-v2\n [*] --> New : Submit accepted\n New --> Ready : Validated and certified\n Ready --> Dispatched : Queued for channel dispatch\n Dispatched --> Sent : Operator accepted message for routing\n Sent --> Delivered : Delivery confirmation received\n Delivered --> Read : Recipient opened message (RCS only)\n Delivered --> Closed : Lifecycle complete\n Read --> Closed : Lifecycle complete\n Sent --> Closed : TimeToLive elapsed\n Sent --> Failed : Recoverable delivery failure\n Failed --> Closed : Closed after failure\n"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State: Failed"]}," is recoverable and does not make the communication final. Wait for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," and inspect the final ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]},"; permanent failure is represented by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome: Failed"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-state-transitions","__idx":4},"children":["Key state transitions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New → Ready → Dispatched"]}," — These three transitions happen in rapid succession within a single processing step. By the time the platform fires the first callback, the message is typically already at ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},". The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}," event occurs before ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", but their callbacks are delivered and retried independently."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Dispatched → Sent"]}," — The SMS or RCS operator accepted the message for routing."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sent → Delivered"]}," — A delivery confirmation was received from the operator. For SMS this is a delivery receipt; for RCS this is a delivery acknowledgement."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delivered → Read"]}," — The recipient opened the message. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RCS only"]},", and only when the operator and recipient device support read receipts. This state is not reachable via SMS."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delivered / Read / TTL / terminal failure → Closed"]}," — Plain SMS normally closes after delivery. RCS closes once the required delivery and read signals are available, or when the TTL elapses. A terminal failure also closes the lifecycle."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"submit-a-certified-message","__idx":5},"children":["Submit a certified message"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"POST /v1/EviSms/Submit\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"eviId\": \"...\" }"]}," on success."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"required-fields","__idx":6},"children":["Required fields"]},{"$$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":["Text"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The content of the SMS or RCS message. This is the certified content delivered to the recipient."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient.PhoneNumber"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The recipient's mobile number in E.164 format (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["+34600000000"]},")."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"useful-fields-you-should-configure","__idx":7},"children":["Useful fields you should configure"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]}," — your own correlation key, filterable in Query. No uniqueness enforced server-side."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]}]}," — the legal name or short identifier of the sending organisation, recorded in the certification evidence. This is ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["not"]}," the sender shown in the recipient's inbox — the inbox sender (the alphanumeric sender ID or number) is configured at the account level, separately from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient.LegalName"]}]}," — the legal name of the recipient, recorded in the certification evidence."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"options","__idx":8},"children":["Options"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All delivery and certification configuration lives inside the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," object."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every field in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Options"]}," is optional at the API level. When you omit one, the platform applies a default — for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}," follows your site's configured language and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," follows the account's configured default method. The web submission form pre-selects these same defaults, which is why they can look mandatory in the portal — but the API only requires the fields listed under ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#required-fields"},"children":["Required fields"]}," above. The only conditional requirement is the challenge pair when ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Challenge"]},"."]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]}]}," — the legal framework applied. Supported values include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced"]},", and regional variants such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Standard_EU"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Advanced_EU"]},". Available levels depend on your account subscription."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]}]}," — the channel or channels to use. Supported values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RCS"]},". When both are specified, Namirial Notify attempts delivery in priority order. See ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"#delivery-channels"},"children":["Delivery channels"]}," below."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TimeToLive"]}]}," — minutes the platform will attempt delivery before the message expires. Range: 60–86,400 (1 hour to 60 days)."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}]}," — language for any platform-generated notification text. Accepted values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ca"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["de"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["en"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["es"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fr"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["it"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pt-BR"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ro"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitLanguage"]}]}," — language for generated affidavit PDFs. Accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["el"]}," (Greek) in addition to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Language"]}," values."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryAppearance"]}]}," — controls whether the delivered message uses the certified presentation or the plain ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AsIs"]}," appearance."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceAccessControlMethod"]}]}," — controls how the recipient accesses 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":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnlineRetentionPeriod"]}]}," — number of years the message and its evidence remain accessible online."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[":::info EviSMS does not support commitment"," ","EviSMS has no accept/reject (commitment) functionality. If you need acceptance or rejection workflows, use ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}," instead — it exposes this through a field named ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CommitmentChoice"]},"."," ",":::"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"callbacks","__idx":9},"children":["Callbacks"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}]}," — HTTPS endpoint to receive state callbacks. Must be publicly reachable."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}]}," — state transitions that trigger a callback. Valid values: ",{"$$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":"code","attributes":{},"children":["AffidavitPublished"]}," is a platform meta-event that fires when affidavit generation completes — it is not a lifecycle state."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}]}," — arbitrary string echoed back in every callback. Use it to embed a routing key or internal record ID."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"idempotency","__idx":10},"children":["Idempotency"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," on every Submit. Use a UUID and keep it constant across retries. A replay of a previously ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," submission returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]},"; the message is not resubmitted."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-channels","__idx":11},"children":["Delivery channels"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]}," accepts ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RCS"]},", or both. When both are specified, the platform attempts delivery in the order listed."]},{"$$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":"Channel"},"children":["Channel"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Delivery evidence"},"children":["Delivery evidence"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Read evidence"},"children":["Read evidence"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fallback"},"children":["Fallback"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SMS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operator delivery receipt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Not supported"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["—"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["RCS"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operator delivery acknowledgement"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Supported where operator and device allow"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Falls back to SMS when specified as second channel"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recommended pattern for maximum reach with read evidence:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"\"DeliveryChannels\": [\"RCS\", \"SMS\"]\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This attempts RCS first (with read receipt support) and falls back to SMS if RCS is unavailable. When the fallback fires, the state machine continues normally — ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," still apply regardless of which channel succeeded."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"callbacks-and-what-you-receive","__idx":12},"children":["Callbacks and what you receive"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When a state in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," is reached, Namirial Notify sends an HTTP POST to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"base-payload","__idx":13},"children":["Base payload"]},{"$$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":["Identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Unique ID of this callback delivery. Use it to deduplicate — the platform retries on non-2xx and on timeouts."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Kind"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The state or event that triggered this callback (e.g. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]},")."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Date"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["datetime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp of the state transition."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceId"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UUID"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]}," of the EviSMS, as returned at submission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceType"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Always ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviSMS"]}," for EviSMS callbacks."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["EvidenceState"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current state at the time the callback was sent."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Owner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Identifier of the account that submitted the message."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OwnerEmail"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address of the submitting account."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Event-specific fields. Always includes the fields listed below."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additionaldata-fields--always-present","__idx":14},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," fields — always present"]},{"$$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":["Source"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The sender display name (the account-configured sender), not the submitted ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Destination"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient phone number."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The integrator-assigned lookup key set at submission."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["State"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Current lifecycle state."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CreationDate"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Timestamp when the message was submitted."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ExtraData"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}," value set at submission, if provided."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"additionaldata-fields--per-event","__idx":15},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AdditionalData"]}," fields — per event"]},{"$$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":"Callback Kind"},"children":["Callback ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Kind"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Extra fields"},"children":["Extra fields"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome"]}," — the final outcome of the message lifecycle. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OutcomeDescription"]}," — human-readable description of the outcome."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitId"]}," — unique ID of the generated affidavit. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKind"]}," — the kind generated. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitName"]}," — filename of the affidavit PDF."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"callback-reliability","__idx":16},"children":["Callback reliability"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make your handler idempotent, keyed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]},". Return ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2xx"]}," promptly. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationExtraData"]}," to embed a routing key for correlation without a separate API call."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"states-reference","__idx":17},"children":["States reference"]},{"$$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":["Unknown"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["State is not known or has not been mapped."]}]},{"$$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 has been staged but not yet submitted."]}]},{"$$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 has been validated, certified, and queued for dispatch. Transitions to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," immediately."]}]},{"$$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":["Message has been handed to the sending process and is ready for the 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":["Delivery confirmation received from the operator."]}]},{"$$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. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RCS only"]},", where the operator and device support read receipts."]}]},{"$$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":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]},":"]}," this state is extremely transient — the platform moves from ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," in the same processing step. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}," event occurs before ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]},", but their callbacks are delivered and retried independently, so do not rely on callback arrival order."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["On ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]},":"]}," only reachable via RCS. When the delivery channel is SMS, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}," will never fire. Plan your callback handling to treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}," as optional enrichment rather than a required step."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"evidence-and-affidavits","__idx":18},"children":["Evidence and affidavits"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}," selects which evidence events generate signed affidavit PDFs. Generation is asynchronous; you receive an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," callback when each affidavit is ready."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"when-each-affidavit-is-generated","__idx":19},"children":["When each affidavit is generated"]},{"$$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":"AffidavitKinds value"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}," value"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Triggers at"},"children":["Triggers at"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Submitted"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies the message content at submission time."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SubmittedAdvanced"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced variant with extended content certification."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TransmissionResult"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies the outcome of the send attempt via the delivery channel."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryResult"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies delivery confirmation from the operator."]}]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies that the recipient opened the message. RCS only."]}]},{"$$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":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies the end of the message lifecycle."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ClosedAdvanced"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced variant of the closure affidavit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Complete"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Certifies the full chain from submission to closure."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CompleteAdvanced"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced variant of the complete lifecycle affidavit."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Event"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Various technical events"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Internal technical record for events without a more specific affidavit kind."]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"querying-status","__idx":20},"children":["Querying status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the Query endpoint as a fallback when callbacks lag, for point-in-time snapshots, or for batch reconciliation."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"GET /v1/EviSms/Query\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Limit"]}," is omitted, the API defaults to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["100"]},". The default drops to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["25"]}," when affidavit metadata is included."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Common filters:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithLookupKeys=your-key"]}," — fetch by your correlation key."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["OnState=Closed"]}," — fetch only closed messages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["WithOutcome=Delivered"]}," — fetch by final outcome."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"first-call-walkthrough","__idx":21},"children":["First-call walkthrough"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"what-you-need","__idx":22},"children":["What you need"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Namirial Notify credentials (username and password)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A recipient mobile number for testing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["An HTTPS endpoint to receive callbacks (or use a tool like ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://webhook.site"},"children":["Webhook.site"]}," for initial testing)"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-1--submit-your-first-message","__idx":23},"children":["Step 1 — Submit your first message"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/EviSms/Submit\nAuthorization: Basic \nContent-Type: application/json\nX-Evi-IdempotencyToken: \n\n{\n \"Text\": \"This is a test certified SMS message.\",\n \"LookupKey\": \"test-001\",\n \"IssuerName\": \"TestCo\",\n \"Recipient\": {\n \"PhoneNumber\": \"+34600000000\"\n },\n \"Options\": {\n \"CertificationLevel\": \"Standard_EU\",\n \"DeliveryChannels\": [\"SMS\"],\n \"AffidavitKinds\": [\"Submitted\", \"DeliveryResult\", \"Closed\"],\n \"PushNotificationUrl\": \"https://your-endpoint.example.com/callbacks\",\n \"PushNotificationFilter\": [\"Sent\", \"Delivered\", \"Closed\", \"AffidavitPublished\"]\n }\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["200 OK"]}," response contains ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{ \"eviId\": \"...\" }"]},". Store the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-2--verify-the-message-progresses","__idx":24},"children":["Step 2 — Verify the message progresses"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/EviSms/Query?WithLookupKeys=test-001\nAuthorization: Basic \n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Confirm the message moves through ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["New"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-3--confirm-delivery","__idx":25},"children":["Step 3 — Confirm delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Confirm that a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," callback fires and that ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentOn"]}," is populated in the Query response. If the operator provides a delivery signal, also verify the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," callback and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveredOn"]},". If you requested a delivery affidavit, verify that the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryResult"]}," affidavit appears through an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," callback; the affidavit kind alone is not proof of successful delivery."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"step-4--test-the-failure-path","__idx":26},"children":["Step 4 — Test the failure path"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Submit a message to a well-formed number that is known to return a permanent delivery failure. Confirm the test number with your Namirial Notify contact so the result is deterministic. Verify that:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The message reaches ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}," then ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Closed"]}," with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome: Failed"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Failed"]}," callback fires to your endpoint"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"integration-checklist","__idx":27},"children":["Integration checklist"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["LookupKey"]}," on every Submit and persist ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["eviId"]}," from the response."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Evi-IdempotencyToken"]}," (UUIDv4) on every Submit. Treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202 Accepted"]}," as success."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IssuerName"]}," to the issuer's legal name or identifier for the evidence record. It does not control the sender shown in the recipient's inbox."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When using ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[\"RCS\", \"SMS\"]"]}," as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]},", handle callbacks for both channels — the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," callbacks fire regardless of which channel succeeded."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Do not rely on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Ready"]}," callbacks for business logic — the state is transient and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," follows immediately."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Subscribe to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}," only if you specifically need read receipt evidence and are using RCS — it will never fire for SMS-only deliveries."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Include ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," if you download affidavits programmatically."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Make your callback handler idempotent, keyed on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Use Query as a fallback when callbacks lag."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"troubleshooting","__idx":28},"children":["Troubleshooting"]},{"$$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":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely causes"},"children":["Likely causes"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What to check"},"children":["What to check"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"What to do"},"children":["What to do"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["No callbacks received"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationUrl"]}," missing or unreachable; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PushNotificationFilter"]}," omits the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Kind"]}," you expect; endpoint returned non-2xx and retries exhausted"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query state directly; server access logs for the callback ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Identifier"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm URL and filter; use Query polling as fallback"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message stays in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Dispatched"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Sent"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Operator processing delay; recipient device off or unreachable"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SentOn"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveredOn"]}," timestamps in Query"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wait; do not resubmit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Recipient did not receive the SMS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong number; operator routing issue; spam filter on device"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Delivered"]}," callback and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveredOn"]}," timestamp"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Confirm the number is valid E.164; retry with a new idempotency token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}," callback never fires"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delivery channel is SMS (not RCS); recipient device does not support RCS read receipts; operator does not pass read events"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DeliveryChannels"]}," in your submit request"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Expected behaviour for SMS — treat ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Read"]}," as optional enrichment"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Message closed with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Outcome: Failed"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A processing or transmission failure was recorded before closure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["FailedOn"]},", callback payloads, and failure details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Correct the number or configuration; resubmit with a new idempotency token only after the cause is fixed"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Affidavit not available"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Generation is asynchronous; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]}," has not fired yet; the kind was not included in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitKinds"]}," at submission"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Query with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["IncludeAffidavits=true"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wait for ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["AffidavitPublished"]},"; if kind is missing it cannot be added retroactively — resubmit"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["400 Bad Request"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Missing ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Text"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Recipient.PhoneNumber"]},"; invalid ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["CertificationLevel"]},"; other field-level validation failure"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["responseStatus.errors[]"]}," for field-level details"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Fix the flagged field; retry with a new idempotency token"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["401 Unauthorized"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Wrong environment base URL; credentials rotated"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Authorization"]}," header; confirm target environment"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Re-issue credentials"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Submit → ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["403 Forbidden"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account not provisioned for EviSMS"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Account permissions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Contact your Namirial Notify account manager"]}]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":29},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/apis/evisms-api"},"children":["EviSMS API"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/issuer/create-evisms"},"children":["How to create a new EviSMS"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evimail"},"children":["EviMail"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/products/namirialnotify/services/evinotice"},"children":["EviNotice"]}]},{"$$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/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","id":"evisms","depth":1},{"value":"When to use EviSMS","id":"when-to-use-evisms","depth":2},{"value":"How EviSMS works","id":"how-evisms-works","depth":2},{"value":"Lifecycle overview","id":"lifecycle-overview","depth":3},{"value":"Key state transitions","id":"key-state-transitions","depth":3},{"value":"Submit a certified message","id":"submit-a-certified-message","depth":2},{"value":"Required fields","id":"required-fields","depth":3},{"value":"Useful fields you should configure","id":"useful-fields-you-should-configure","depth":3},{"value":"Options","id":"options","depth":3},{"value":"Callbacks","id":"callbacks","depth":3},{"value":"Idempotency","id":"idempotency","depth":3},{"value":"Delivery channels","id":"delivery-channels","depth":2},{"value":"Callbacks and what you receive","id":"callbacks-and-what-you-receive","depth":2},{"value":"Base payload","id":"base-payload","depth":3},{"value":"AdditionalData fields — always present","id":"additionaldata-fields--always-present","depth":3},{"value":"AdditionalData fields — per event","id":"additionaldata-fields--per-event","depth":3},{"value":"Callback reliability","id":"callback-reliability","depth":3},{"value":"States reference","id":"states-reference","depth":2},{"value":"Evidence and affidavits","id":"evidence-and-affidavits","depth":2},{"value":"When each affidavit is generated","id":"when-each-affidavit-is-generated","depth":3},{"value":"Querying status","id":"querying-status","depth":2},{"value":"First-call walkthrough","id":"first-call-walkthrough","depth":2},{"value":"What you need","id":"what-you-need","depth":3},{"value":"Step 1 — Submit your first message","id":"step-1--submit-your-first-message","depth":3},{"value":"Step 2 — Verify the message progresses","id":"step-2--verify-the-message-progresses","depth":3},{"value":"Step 3 — Confirm delivery","id":"step-3--confirm-delivery","depth":3},{"value":"Step 4 — Test the failure path","id":"step-4--test-the-failure-path","depth":3},{"value":"Integration checklist","id":"integration-checklist","depth":2},{"value":"Troubleshooting","id":"troubleshooting","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"EviSMS","description":"End-to-end integration guide for EviSMS — certified SMS and RCS communications through Namirial Notify.","layout":"doc","outline":"deep","keywords":["evisms","certified sms","certified rcs","sms evidence","rcs delivery","mobile delivery evidence","affidavit","namirial notify"],"seo":{"title":"EviSMS"}},"lastModified":"2026-08-03T09:35:33.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/namirialnotify/services/evisms","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}