RingCentral
| Schemes | ringc:// |
| Cargo feature | service-ringcentral |
| Service | https://ringcentral.com/ |
| Body formats | text (first is the default) |
| Attachments | yes |
| 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}://{from_phone}:{token}@{client_id}/{secret}/
{schema}://{from_phone}:{token}@{client_id}/{secret}/{targets}
{schema}://{token}@{client_id}/{secret}/{from_phone}
{schema}://{token}@{client_id}/{secret}/{from_phone}/{targets}
{schema} is one of ringc://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{client_id} | Client ID | string | yes | secret; must match ^[a-z0-9_-]+$ | |
{from_phone} | From Phone No | string | yes | ||
{secret} | Client Secret | string | yes | secret; must match ^[a-z0-9_-]+$ | |
{target_phone} | Target Phone No | string | no | prefix + | |
{targets} | Targets | list | no | any of target_phone; separated by / | |
{token} | Token / Password | string | yes | secret |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
env | Environment | choice | prod | one of prod; sandbox is rejected: RingCentral retired its sandbox on 2025-01-01 |
from | From Phone No | string | sets {from_phone} | |
mode | Authentication Mode | choice | one of basic, jwt | |
secret | Client Secret | string | sets {secret} | |
source | From Phone No | string | sets {from_phone} | |
to | Targets | list | sets {targets} | |
token | Token / Password | string | sets {token} |
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):
ringc://15551232000:password@clientid/secret
ringc://password@clientid/secret/15551232000/15551232001
ringc://15551232000:password@clientid/secret/15551232001
ringc://15551232000:password@clientid/secret?env=prod
ringc://15551232000:eyJ0eXAi.abc-def_1@clientid/secret?mode=jwt
ringc://x:y@clientid/secret?source=15551232000
ringc://x:y@clientid/oldsecret?secret=newsecret&from=15551232000&to=15551232009&token=tok
ringc://x@clientid/secret/15551232000?token=eyJhbGciOiJSUzI1NiJ9.eyJhdWQiOiJodHRwczovL3BsYXRmb3JtLnJpbmdjZW50cmFsLmNvbSJ9.sig
Rejected URLs:
ringc://
ringc://15551232000:password@clientid
ringc://15551232000:password@client!id/secret
ringc://15551232000:password@clientid/sec!ret
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'ringc://15551232000:password@clientid/secret'
Notes
RingCentral (ringc://): SMS through the RingCentral API.
Logs in (OAuth password or JWT grant) and sends one SMS/MMS per target. A token with a positive lifetime is kept in memory (a non-persistent store entry) and reused until it expires; Target::close revokes it.
Differences with Apprise
?env=sandboxsends toplatform.devtest.ringcentral.comin Apprise, while mercurio rejects it: RingCentral retired that sandbox on 2025-01-01.