Aller au contenu
Apprise Apprise Apprise Documentation

X (Formerly Twitter) Notifications

Ce contenu n’est pas encore disponible dans votre langue.

Overview

  • Source: https://x.com/
  • Image Support: No
  • Attachment Support: Yes
  • Message Character Limits:
    • Private Message: 25000
    • Tweet: 280

Account Setup

Section titled “Account Setup”

You need to register to X developer account at developer.x.com.

X Direct Messages are slightly more complicated then some of the other notification services, so here is quick breakdown of what you need to know and do in order to send Notifications through it using this tool:

If there are Project and App

Section titled “If there are Project and App”

When you registered to X developer account, you may have already created a default project and app. You can use this app and it’s through an X App we will be able to send our DMs.

  1. First off, you’ll need to regenerate the API Keys. This is done by accessing the app name under Projects & Apps (on left menu), then under the Consumer Keys from the “Keys and tokens” Tab. Once generated, copy it to a safe place. This is Consumer Keys.
    X Generate Tokens

  2. Next, grant the appropriate access permissions so that you can post or send DMs. After clicking on the app name under Projects & Apps (on left menu), click on Set up under the User authentication settings section.
    X User authentication set up
    On the User authentication settings page, set the following

    • App permissions
      Select Read and write if you want to post only. If you want to send DMs, select Read and write and Direct message.
    • Type of App
      Select Web App, Automated App or Bot
    • App info
      Enter any URL for Callback URI / Redirect URL and Website URL. If you are using Apprise to send posts or DMs, it doesn’t matter what you enter.

    Once you entered them all, click Save.

  3. Lastly, you’ll need to regenerate the Access Tokens. This is done under the Authentication Tokens from the “Keys and tokens” Tab. Once generated, copy it to a safe place.
    X Generate Tokens

If there is no Project and App

Section titled “If there is no Project and App”

  1. First off, you need to create a project and an X App (not Standalone apps) from developer.x.com. It’s through an X App we will be able to send our DMs.
    X Create Project
    X asks you to justify why you need it as long as you specify the purpose of your app in detail.

  2. Once you created the app, you’ll see the API Tokens on the screen, so copy it to a safe place. This is Consumer Keys.
    X App API Key

  3. Next, grant the appropriate access permissions so that you can post or send DMs. After clicking on the app name under Projects & Apps (on left menu), click on Set up under the User authentication settings section.
    X User authentication set up
    On the User authentication settings page, set the following

    • App permissions
      Select Read and write if you want to post only. If you want to send DMs, select Read and write and Direct message.
    • Type of App
      Select Web App, Automated App or Bot
    • App info
      Enter any URL for Callback URI / Redirect URL and Website URL. If you are using Apprise to send posts or DMs, it doesn’t matter what you enter.

    Once you entered them all, click Save.

  4. Lastly, you’ll need to generate the Access Tokens. This is done under the Authentication Tokens from the “Keys and tokens” Tab. Once generated, copy it to a safe place.
    X Generate Tokens

You should now have the following 4 tokens ready to use.

  • A Consumer Key (An API Key)
  • A Consumer Secret (An API Secret)
  • An Access Token
  • An Access Token Secret

From here you’re ready to go. You can post public posts or simply create DMs through the use of the mode= variable. By default Direct Messaging (DM) is used.

Syntax

Section titled “Syntax”

Valid syntax is as follows:

  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}
  • twitter://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}

Or

  • x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}
  • x://{ScreenName}@{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}

If you know the targets you wish to identify; they can be targeted by their X Screen Name:

  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName}
  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName1}/{ScreenName2}/{ScreenNameN}

Or

  • x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName}
  • x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}/{ScreenName1}/{ScreenName2}/{ScreenNameN}

[!NOTE] If no ScreenName is specified, then by default the Direct Message is sent to your own account.

A Public post can be referenced like so:

  • twitter://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet
  • x://{ConsumerKey}/{ConsumerSecret}/{AccessToken}/{AccessSecret}?mode=tweet

Parameter Breakdown

Section titled “Parameter Breakdown”
VariableRequiredDescription
ScreenNameYesThe UserID of your account such as l2gnux (if your id is @l2gnux). You must specify a {userid} or an {ownerid}.
ConsumerKeyYesThe Consumer Key (API Key)
ConsumerSecretYesThe Consumer Secret Key (API Secret Key)
AccessTokenYesThe Access Token; you would have had to generate this one from your X App Configuration.
AccessSecretYesThe Access Secret; you would have had to generate this one from your X App Configuration.
ModeNoThe X mode you want to operate in. Possible values are dm (for Private Direct Messages) and tweet to make a public post. By default this is set to dm
batchNoBy default images are batched together. However if you want your attachments to be posted 1 post per attachment, set this to False.

Global Parameters

Section titled “Global Parameters”
VariableDescription
overflowThis parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream
👉 upstream: Do nothing at all; pass the message exactly as you received it to the service.
👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated.
👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after.
formatThis parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored.
verifyExternal requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes.
ctoThis stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds.
rtoThis stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds.
emojisEnable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no.
Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case.
tzIdentify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area.

Examples

Section titled “Examples”

Send a X DM to @testaccount:

Terminal window
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
# our user is @testaccount
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3

Or

Terminal window
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
# our user is @testaccount
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   x://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3

Send a public post:

Terminal window
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet

Or

Terminal window
# Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   x://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3?mode=tweet