Vonage
| Schemes | vonage://, nexmo:// |
| Cargo feature | service-vonage |
| Service | https://dashboard.nexmo.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}@{from_phone}
{schema}://{apikey}:{secret}@{from_phone}/{targets}
{schema} is one of vonage://, nexmo://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{apikey} | API Key | string | yes | secret; must match ^[a-z0-9]+$ | |
{from_phone} | From Phone No | string | yes | must match ^\+?[0-9\s)(+-]+$ | |
{secret} | API Secret | string | yes | secret; must match ^[a-z0-9]+$ | |
{target_phone} | Target Phone No | string | no | prefix +; must match ^[0-9\s)(+-]+$ | |
{targets} | Targets | list | no | any of target_phone; separated by / |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
from | From Phone No | string | sets {from_phone}; also source | |
key | API Key | string | sets {apikey} | |
secret | API Secret | string | sets {secret} | |
to | Targets | list | sets {targets} | |
ttl | ttl | int, 20000 to 604800000 | 900000 |
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):
vonage://AChhhhhhhh:iiiiiiiiiiiiiiii@55555555555
nexmo://ACaaaaaaaa:bbbbbbbbbbbbbbbb@55555555555/66666666666/77777777777
vonage://ACffffffff:gggggggggggggggg@33333333333/123/999999999999999/abcd/
vonage://ACbbbbbbbb:cccccccccccccccc@33333333333/?ttl=30000
vonage://_?key=ACaaaaaaaa&secret=bbbbbbbbbbbbbbbb&from=55555555555
vonage://_?key=ACaaaaaaaa&secret=bbbbbbbbbbbbbbbb&source=55555555555
vonage://_?key=ACaaaaaaaa&secret=bbbbbbbbbbbbbbbb&from=55555555555&to=7777777777777
Rejected URLs:
vonage://
vonage://:@/
vonage://ACaaaaaaaa@12345678
vonage://ACaaaaaaaa:bbbbbbbbbbbbbbbb@333333333
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'vonage://AChhhhhhhh:iiiiiiiiiiiiiiii@55555555555'
Notes
Vonage, formerly Nexmo (vonage://, nexmo://): SMS through the Vonage API.