Skip to content

Notify_threema

Chris Caron edited this page Nov 17, 2023 · 6 revisions

Threema Gateway Notifications

Setup

You need to first set up an account with Threema which will grant you access to your Threema 8 character User ID (which starts with an asterix (*). e.g *THREEMA

Account Setup

  • Create your Threema Gateway account at https://gateway.threema.ch/ and confirm your E-Mail address
  • For credits:
    • Ask them via E-Mail for test credits and we will get you covered for some testing
    • OR acquire them after logging into your Gateway account.
  • Request your Simple or E2E Gateway ID. From their, they will then create your ID and you will find the corresponding ID secret on the ID overview page.

Syntax

Valid syntax is as follows:

  • threema://{gateway_id}@{secret}/{user}
  • threema://{gateway_id}@{secret}/{user1}/{user2}/{user3}/{userN}
  • threema://{gateway_id}@{secret}/{email}
  • threema://{gateway_id}@{secret}/{email1}/{email2}/{email3}/{emailN}
  • threema://{gateway_id}@{secret}/{phone}
  • threema://{gateway_id}@{secret}/{phone1}/{phone2}/{phone3}/{phoneN}

You can freely mix/match the variables as well:

  • threema://{gateway_id}@{secret}/{phone1}/{user1}/{email1}/...

Parameter Breakdown

Variable Required Description
gateway_id Yes Your Gateway ID (8 characters that usually start with a +. You may use ?from= (or gwid) as an alias to this variable. These usually start with an asterisk (*) such as *MYGWYID
secret Yes Your Threema API Secret associated with your account. You may use ?secret= as an alias to this variable.
target No Specfiy Threema UserID, Email Address, or Phone No. If no target is specified then your User ID is used instead. There is no limit to the number of targets you specify. You may use ?to= as an alias to this variable.

Example

Send a Threema (Gateway) Simple notification

# Assume:
#  - our {gateway_id} is *MYGWYID
#  - our {secret} is abc123-2345
#  - The {toPhoneNo} is 6135551234
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   threema://*MYGWYID@abc123-2345/6135551234

Send a Threema (Gateway) Simple notification to another Threema User:

# Assume:
#  - our {gateway_id} is *MYGWYID
#  - our {secret} is abc123-2345
#  - The {toThreemaID} is FRIENDID
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   threema://*MYGWYID@abc123-2345/FRIENDID
Clone this wiki locally