v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Send SMS using a Pool

Sends a single SMS using a pool

post/pools/my/{poolId}/sms

Path parameters

poolIdstring required

The tracking id of the pool.

Headers

Content-Typestring required

application/json

Authorizationstring required

Bearer {access_token}

Request body

tostring required

The recipient of the SMS. Format with a '+' and country code e.g., +3069485xxxxx (E.164 format).

poolStrategystring required

The strategy to follow when picking a sender from the pool. Values: Numeric, Alphanumeric

bodystring required

The body of the SMS message.

Response

200

trackingIdstring

statusstring

createdAtstring

poolIdstring

poolNamestring

poolStrategystring

tostring

fromstring

bodystring

Example response

{
  "trackingId": "9004c273-6397-4c56-a615-7f5490c4305c",
  "status": "Queued",
  "createdAt": "2018-11-20T15:01:41.272Z",
  "poolId": "4af48a7d-8c65-4e8b-91ab-34d2cb0c2efa",
  "poolName": "demo pool",
  "poolStrategy": "Numeric",
  "smsSettings": {
    "sticky": true,
    "geomatch": true,
    "alphanumericSenderId": "sender"
  },
  "to": "+306948xxxxxx",
  "from": "306988xxxxxx",
  "body": "Send SMS using a pool",
  "bodyAnalysis": {
    "parts": 1,
    "characters": 21
  },
  "urlShortener": {
    "urlValidity": 12345,
    "urls": [
      {
        "longUrl": "https://long.url.com",
        "shortUrl": "https://shrt.com"
      }
    ]
  }
}