Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Threema Gateway

Schemesthreema://
Cargo featureservice-threema
Servicehttps://gateway.threema.ch/
Body formatstext (first is the default)
Attachmentsno
Title lengthno title (merged into the body)
Body length3,500 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedno

URL formats

{schema}://{gateway_id}@{secret}/{targets}

{schema} is one of threema://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{gateway_id}Gateway IDstringyessecret
{secret}API Secretstringyessecret
{target_email}Target Emailemailno
{target_phone}Target Phone Nostringnoprefix +; must match ^[0-9\s)(+-]+$
{target_threema_id}Target Threema IDstringno
{targets}Targetslistyesany of target_email, target_phone, target_threema_id; separated by /

Query parameters

ParameterMeaningTypeDefaultNotes
fromGateway IDstringsets {gateway_id}
gwidGateway IDstringsets {gateway_id}
secretAPI Secretstringsets {secret}
toTargetslistsets {targets}

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):

threema://*THEGWID@secret/ECHOECHO/
threema://*THEGWID@secret/user@example.com
threema://*THEGWID@secret/16134442222/16134443333/
threema://*THEGWID@secret/ECHOECHO/user@example.com/+1 613 444 2222/bad
threema:///?secret=secret&gwid=*THEGWID&to=16134442222
threema:///?secret=secret&from=*THEGWID&to=16134442222,ECHOECHO

Rejected URLs:

threema://
threema://@:
threema://user@secret
threema:///?gwid=*THEGWID&to=ECHOECHO

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'threema://*THEGWID@secret/ECHOECHO/'

Notes

Threema Gateway (threema://): messages through the Threema Gateway API.