Skip to main content
Send a transactional SMS message using the Antryk SMS Service.
curl --request POST \
  --url https://ses.antryk.com/api/v1/sms/send \
  --header 'Content-Type: application/json' \
  --data '{
    "accessKey": "YOUR_ACCESS_KEY",
    "secretKey": "YOUR_SECRET_KEY",
    "to": "+1XXXXXXXXXX",
    "serviceId": "YOUR_SERVICE_ID"
  }'

Request Parameters

accessKey
string
required
The SMS service access key generated in the Antryk Console. Requests fail with 401 if missing or invalid.
secretKey
string
required
Secret key paired with the access key. Do not expose this in client-side code. Missing keys return 401 invalid credentials.
to
string
required
Recipient phone number in E.164 format (e.g. +1XXXXXXXXXX). Requests return 400 invalid_recipient for malformed numbers.
serviceId
string
required
Identifier of the SMS service configuration. Use the value from the console. Missing or disabled services return 404 service_not_found.

Successful Response

{
  "success": true,
  "messageId": "msg_5QZ9S6",
  "to": "+1XXXXXXXXXX",
  "queuedAt": "2025-11-06T11:21:00.000Z"
}

Error Scenarios

  • 401 invalid credentialsaccessKey or secretKey missing/incorrect
  • 400 invalid_recipientto not in E.164 or empty
  • 404 service_not_foundserviceId missing, revoked, or disabled
  • 429 rate_limited – service exceeds per-minute quota
  • 500 provider_unavailable – upstream SMS provider outage; retry with backoff
Always validate phone numbers and throttle retries to avoid rate limiting.