Vai al contenuto

Submit a certified SMS

Richiesta

Sicurezza
basicAuth
Intestazioni
X-Evi-IdempotencyTokenstring

Optional idempotency token (UUID recommended) to prevent duplicate submissions on retry. A replay of a cached 200 OK submission returns 202 Accepted. Responses 400, 401, 408, 409, 429, and 5xx are not cached for replay.

Corpoapplication/jsonobbligatorio
Textstringobbligatorio
LookupKeystring
IssuerNamestring

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).

Recipientobject(EviSmsRecipient)obbligatorio
Optionsobject(EviSmsOptions)
curl -i -X POST \
  -u '<username>:<password>' \
  https://api.evicertia.com/v1/EviSms/Submit \
  -H 'Content-Type: application/json' \
  -H 'X-Evi-IdempotencyToken: string' \
  -d '{
    "Text": "We inform you that your request has been processed.",
    "LookupKey": "SMS-001",
    "IssuerName": "SendCo",
    "Recipient": {
      "LegalName": "Recipient Corp.",
      "PhoneNumber": "+34600000000"
    },
    "Options": {
      "CertificationLevel": "Advanced_EU",
      "DeliveryChannels": [
        "SMS"
      ],
      "TimeToLive": 11400,
      "Language": "es",
      "AffidavitLanguage": "es",
      "AffidavitKinds": [
        "Submitted",
        "TransmissionResult",
        "DeliveryResult",
        "Closed",
        "CompleteAdvanced"
      ],
      "PushNotificationFilter": [
        "Ready",
        "Sent",
        "Dispatched",
        "Delivered",
        "Failed",
        "Closed",
        "AffidavitPublished"
      ],
      "PushNotificationUrl": "https://your-system.example.com/callbacks/evisms",
      "EvidenceAccessControlMethod": "Challenge",
      "EvidenceAccessControlChallenge": "What is your mother'\''s maiden name?",
      "EvidenceAccessControlChallengeResponse": "Smith",
      "OnlineRetentionPeriod": 1
    }
  }'

Risposte

SMS accepted

Intestazioni
X-Evi-IdempotencyStatusstring

Idempotency outcome for the submission request.

Value:"New"
Corpoapplication/json
eviIdstringobbligatorio
Risposta
{ "eviId": "string" }