Siųsti SMS paketą (API)

Be pavienės SMS siuntimo, taip pat galite siųsti SMS paketą naudodami šį endpoint.

POST

/sms/send/bulk

Užklausos duomenys

Antraštės

X-Api-Key

required

string

API raktas jūsų darbo erdvei.

JSON duomenys

messages

required

array

Siunčiamų žinučių masyvas.

sender

required

string

Siuntėjo vardas SMS.

recipient

required

string

format: E.164

Gavėjo numeris (E.164 formatu) SMS.

content

required

string

Siunčiamos SMS turinys.

unicode

string

Valdo, kaip apdorojami Unicode simboliai šiai žinutei. Galimos reikšmės: Allow, Deny ir Strip.

clientReference

string

Jūsų pačių nuoroda šiai žinutei, naudinga atsiskaitymui, analitikai ir pristatymo ataskaitų susiejimui su jūsų sistema.

sendAtUtc

string

format: date-time (ISO 8601)

Data (UTC) ISO 8601 formatu, kada SMS turėtų būti suplanuota. Jei nenurodyta, SMS bus išsiųsta iš karto.

enableLinkShortening

boolean

Perrašo jūsų darbo erdvės nuorodų trumpinimo nustatymą šiam paketui. Nustatykite true, kad įjungtumėte nuorodų trumpinimą šio siuntimo žinutėms, arba false, kad išjungtumėte.

Atsakymo duomenys

JSON duomenys

batchId

string

format: long / int64

SMS paketo ID iš Connect.

messageCount

number

Žinučių skaičius pakete.

errors

array

Kai dalis žinučių neatitinka validacijos, bet kitos priimamos, šiame lauke pateikiamas žinutės indeksas ir validacijos klaida kiekvienam nepavykusiam elementui.

Jei dalis žinučių priimamos, o dalis neatitinka validacijos, API grąžina 207 Multi-Status su priimtu messageCount ir errors masyvu.

Integracijos pavyzdys

curl -X POST https://connect-api.divergent.cloud/sms/send/bulk \
  -H "X-Api-Key: { API_KEY }" \
  --json '{
    "sendAtUtc": "2026-05-21T12:00:00Z",
    "enableLinkShortening": true,
    "messages": [
      {
        "sender": "{ SENDER_NAME }",
        "recipient": "{ RECIPIENT_NUMBER }",
        "content": "{ CONTENT }",
        "unicode": "Allow",
        "clientReference": "{ CLIENT_REFERENCE }"
      }
    ]
  }'