Send SMS using a Pool

Sends a single SMS using a pool

RESPONSE PARAMETERS

KEY

DESCRIPTION

trackingId

The tracking Id of the SMS message.

status

The status of the SMS. Check here for possible values.

createdAt

The date that this resource was created.

poolId

The trackingId of the pool.

poolName

The name of the pool.

poolStrategy

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

smsSettings

The SMS settings of the pool

smsSettings.sticky

When enabled, the service should try to always use the same number, as sender, for each recipient.

smsSettings.geomatch

When enabled, the service should try to use, as sender, a number that matches the destination country.

smsSettings.transcode

When enabled, the SMS message will get transcoded (when possible).

smsSettings.defaultCountry

A country code in ISO 3166-1 alpha-2 format. Routee will use a number from this defaultCountry as sender, if there is not a more suitable option (eg a number from the same country or a sticky sender for the recipient).

smsSettings.alphanumericSenderId

The alphanumeric Sender Id that will be used, when the pool strategy is "Alphanumeric".

smsSettings.inboundSMSCallbackUrl

Defines the callback URL that will receive the inbound messages to the numbers of the pool.

smsSettings.callback

Defines the callback URL that will receive the status update notifications for your outbound SMS messages.

smsSettings.callback.url

A URL that Routee will POST to, each time your message status changes.

smsSettings.callback.strategy

Defines when the URL will be called. Two possible values: on every status change (OnChange) or when a final status arrives (OnCompletion).

to

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

from

The sender Id (number or alphanumeric) that picked from the pool (without the '+')

bodyAnalysis

The analysis for the body of the SMS.

bodyAnalysis.characters

The total number of characters of the message body.

bodyAnalysis.parts

The number of actual SMS that will be sent.

bodyAnalysis.transcode

Contains information for the transcoded body of the SMS message. This will be available only if the message can be transcoded.

bodyAnalysis.transcode.message

The transcoded message of the original unicode message.

bodyAnalysis.transcode.parts

The number of the parts of the transcoded message.

bodyAnalysis.unicode

Indicates if the body contains unicode characters.

bodyAnalysis.unsupportedGSMCharacters

Which characters caused the message to be considered as unicode.

urlShortener

Present only if the urlShortener object is present in the request.

urlShortener.urlValidity

The expire time of the shorten URL in seconds. The default system value is preconfigured.

urlShortener.urls

Array of url objects

urlShortener.urls.longUrl

The original long url that was shortened.

urlShortener.urls.shortUrl

The matching short url.

{
  "shortUrl": "https://sends.ms/02l99c",
  "longUrl": "https://www.google.com/",
  "tags": {
     "to":"+3012345678"
  },
  "timestamp": "2021-03-11T09:58:38.829Z",
  "dateTime": "2021-03-11T09:58:38.829+01:00",
  "ip": "18.17.28.101",
  "country": "GR",
  "city": "Thessaloniki",
  "referrer": "UNKNOWN",
  "device": "DESKTOP",
  "browser": "CHROME",
  "lag": 9
}
Language