Send an SMS Message

Overview

This method allows you to send an SMS message. Using TSG Global APIs, you can send outgoing SMS messages from your enabled phone numbers to mobile phones around the globe.

Authentication

Authentication is done by passing your TSG Global API key via the Authorization header in the format "Authorization: Bearer <api_key>"

Method

post
https://sms.tsgglobal.world/messages
Send an SMS message.

Encoding

In most cases, we handle the encoding for you — we’ll efficiently transcode it to either fit ASCII, Latin-1 or UTF-16.
The API supports UTF-8. Characters outside of the Latin-1 set will set the encoding to UCS2 (i.e. UTF-16) You can override the encoding by using the force_encoding field instead.
Below is a table of all the encodings, however only a few are supported for the API.
int
Description
Supported By API
0
SMSC Default Alphabet
Yes
1
IA5/ASCII GSM 03.38 (CCITT T.50)/(ANSI X3.4)
No
2
Octet Unspecified
No
3
Latin 1 (ISO-8859-1)
Yes
4
Octet Unspecified
No
5
JIS (X 0208-1990)
No
6
Cyrllic (ISO-8859-5)
No
7
Latin/Hebrew (ISO-8859-8)
No
8
UCS2/UTF-16 (ISO/IEC-10646)
Yes
9
Pictogram Encoding
No
10
Music Codes (ISO-2022-JP)
No
13
Extended Kanji JIS (X 0212-1990)
No
14
Korean Graphic Character Set (KS C 5601/KS X 1001)
No
Good to know: message scheduling can be specified for up to 2 years in advance. We guarantee up to the minute accuracy.

Example Responses

A single message was sent to 9999999 and 12342341234.
{
"9999999": {
"updated_at": "2017-09-28T08:28:39.132046",
"type": "outbound",
"to": "9999999",
"status": "new",
"scheduled_at": null,
"expires_at": null,
"processed_at": null,
"object": "sms",
"location": null,
"inserted_at": "2017-09-28T08:28:39.132037",
"id": "1e7bd5e9-d9ba-41de-814e-3fe755e60e83",
"from": "15550555055",
"encoding": 3,
"delivery_receipt": 0,
"delivered_at": null,
"body": "hello world"
},
"12342341234": {
"updated_at": "2017-09-28T08:28:39.132046",
"type": "outbound",
"to": "12342341234",
"status": "new",
"scheduled_at": null,
"expires_at": null,
"processed_at": null,
"object": "sms",
"location": null,
"inserted_at": "2017-09-28T08:28:39.132038",
"id": "2e6ed7eb-a16f-4e56-b9f2-f66000921da3",
"from": "15550555055",
"encoding": 3,
"delivery_receipt": 0,
"delivered_at": null,
"body": "hello world"
}
}
A 3-part multipart message was sent to 9999999 and 12342341234.
{
"9999999": {
"updated_at": "2017-09-28T08:28:39.132046",
"udh": {
"ref_num": 234,
"count": 3
},
"parts": [
{"id": "3203283d-7a98-49ad-a8d4-17b45a8373b8"},
{"id": "2a87beb4-791c-480d-9b77-1780d785847c"},
{"id": "98c8ec04-54e3-40bb-b256-35ebb5c15280"}
],
"type": "outbound",
"to": "9999999",
"status": "new",
"scheduled_at": null,
"expires_at": null,
"processed_at": null,
"object": "sms",
"location": null,
"inserted_at": "2017-09-28T08:28:39.132037",
"id":"2285c9b4-8b3e-4c72-a30d-a3481a68b6a5",
"from": "15550555055",
"encoding": 3,
"delivery_receipt": 0,
"delivered_at": null,
"body": "hello world [..]"
},
"12342341234": {
"updated_at": "2017-09-28T08:28:39.132046",
"udh": {
"ref_num": 541,
"count": 3
},
"parts": [
{"id": "3322dcb5-d668-4148-b94c-3f4b3faf670e"},
{"id": "b5fe304f-374e-4558-95f7-4a3ffdfb7784"},
{"id": "fbfb2ddc-f7e4-42b5-9bb8-6778f6d45987"}
],
"type": "outbound",
"to": "12342341234",
"status": "new",
"scheduled_at": null,
"expires_at": null,
"processed_at": null,
"object": "sms",
"location": null,
"inserted_at": "2017-09-28T08:28:39.132038",
"id": "2e6ed7eb-a16f-4e56-b9f2-f66000921da3",
"from": "15550555055",
"encoding": 3,
"delivery_receipt": 0,
"delivered_at": null,
"body": "hello world [..]"
}
}