Pingram
| Schemes | pingram:// |
| Cargo feature | service-pingram |
| Service | https://www.pingram.io/ |
| Body formats | text, html (first is the default) |
| Attachments | no |
| Title length | 250 characters |
| Body length | 32,768 characters |
| Body lines | unlimited |
| Request throttle | 200 ms between requests |
| Vendor URLs accepted | no |
URL formats
{schema}://{apikey}/{targets}
{schema}://{type}@{apikey}/{targets}
{schema} is one of pingram://.
URL tokens
| Token | Meaning | Type | Required | Default | Notes |
|---|---|---|---|---|---|
{apikey} | API Key | string | yes | secret; must match ^pingram_(sk|pk)_[\w.-]+$ | |
{target_email} | Target Email | no | |||
{target_id} | Target ID | string | no | prefix @ | |
{target_sms} | Target SMS | string | no | ||
{targets} | Targets | list | no | any of target_email, target_id, target_sms; separated by / | |
{type} | Message Type | string | no | must match ^[A-Z0-9_-]+$; defaults to the app id |
Query parameters
| Parameter | Meaning | Type | Default | Notes |
|---|---|---|---|---|
apikey | API Key | string | sets {apikey} | |
bcc | Blind Carbon Copy | list | separated by , or space | |
cc | Carbon Copy | list | separated by , or space | |
channels | Channels | list | separated by , or space; one of call, email, inapp, mobile_push, slack, sms, web_push | |
from | From Email | string | ||
mode | Mode | choice | one of message, template | |
region | Region Name | choice | us | one of us, ca, eu |
to | Targets | list | sets {targets} | |
type | Message Type | string | sets {type} |
Prefixed parameters:
:name=value: Template Tokens
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):
pingram://pingram_sk_abc123/g@rb@ge/+15551235553/
pingram://pingram_sk_abc123/+15551235553/+15551235554
pingram://pingram_pk_aaaa.bbbb.cccc-dd_ee/user@example.ca
pingram://pingram_sk_abc123/user1@example.com/user2@example.com
pingram://pingram_sk_abc123/+15551235553?region=CA
pingram://pingram_sk_abc123/id/user6@example.ca?bcc=invalid
pingram://pingram_sk_abc123/user@example.ca?from=NotAnEmail
pingram://pingram_sk_abc123/id/user8@example.ca?cc=l2g@nuxref.com
Rejected URLs:
pingram://
pingram://abcd
pingram://pingram_sk_key/+15551235553/?mode=invalid
pingram://pingram_sk_key/+15551235553/?region=invalid
Send one from the command line:
mercurio -t 'Backup' -b 'Finished in 42s' 'pingram://pingram_sk_abc123/g@rb@ge/+15551235553/'
Notes
Pingram (pingram://): messages through the Pingram notification API.