Burst SMS
| Schemes | burstsms:// |
| Cargo feature | service-burstsms |
| Service | https://burstsms.com/ |
| Body formats | text (first is the default) |
| Attachments | no |
| Title length | no title (merged into the body) |
| Body length | 160 characters |
| Body lines | unlimited |
| Request throttle | none |
| Vendor URLs accepted | no |
URL formats
{schema}://{apikey}:{secret}@{sender_id}/{targets}
{schema} is one of burstsms://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{apikey} | API Key | string | yes | secret; must match ^[a-z0-9]+$ | |
{secret} | API Secret | string | yes | secret; must match ^[a-z0-9]+$ | |
{sender_id} | Sender ID | string | yes | ||
{target_phone} | Target Phone No | string | no | prefix +; must match ^[0-9\s)(+-]+$ | |
{targets} | Targets | list | yes | any of target_phone; separated by / |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
batch | Batch Mode | bool | no | |
country | Country | choice | us | one of au, nz, gb, us |
from | Sender ID | string | sets {sender_id}; also source | |
key | API Key | string | sets {apikey} | |
secret | API Secret | string | sets {secret} | |
to | Targets | list | sets {targets} | |
validity | validity | int | 0 |
The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.
Examples
Accepted URLs (tokens are fake):
burstsms://aaaaaaaa:bbbbbbbbbbbbbbbb@Sender/66666666666/77777777777
burstsms://_?key=aaaaaaaa&secret=bbbbbbbbbbbbbbbb&from=55555555555&to=66666666666
burstsms://_?key=aaaaaaaa&secret=bbbbbbbbbbbbbbbb&source=55555555555&to=66666666666&country=gb
burstsms://_?key=aaaaaaaa&secret=bbbbbbbbbbbbbbbb&source=55555555555&to=66666666666&validity=10
burstsms://_?key=aaaaaaaa&secret=bbbbbbbbbbbbbbbb&from=55555555555&to=66666666666,77777777777&batch=y
Rejected URLs:
burstsms://
burstsms://:@/
burstsms://aaaaaaaa@12345678
burstsms://dddddddd:eeeeeeeeeeeeeeee@%20
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'burstsms://aaaaaaaa:bbbbbbbbbbbbbbbb@Sender/66666666666/77777777777'
Notes
Burst SMS (burstsms://): SMS through the Burst SMS API.