extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-12 18:01:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Notify_twitter (markdown)

Chris Caron 2019-06-28 22:31:45 -04:00
parent 136d8f25ec
commit c33b65201b
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Notify_twitter.md

@ -2,10 +2,10 @@
* **Source**: https://twitter.com/ * **Source**: https://twitter.com/
* **Icon Support**: No * **Icon Support**: No
* **Message Format**: Text * **Message Format**: Text
* **Message Limit**: 4096 Characters per message * **Message Limit**: 10000 Characters per message if a private DM otherwise public tweets are limited to 280 character.
### Account Setup ### Account Setup
Twitter Direct Messages (DM) 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: Twitter 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:
1. First off, you need to generate a Twitter App from [apps.twiter.com](https://apps.twitter.com). It's through a Twitter App we will be able to send our DMs. 1. First off, you need to generate a Twitter App from [apps.twiter.com](https://apps.twitter.com). It's through a Twitter App we will be able to send our DMs.
2. Once you create the app, you'll need to **generate the Access Tokens**. This Is done from the "*Keys and Access Tokens*" Tab. 2. Once you create the app, you'll need to **generate the Access Tokens**. This Is done from the "*Keys and Access Tokens*" Tab.
@ -16,30 +16,36 @@ You should now have 4 Tokens to work with at this point on this same page.
* An Access Token * An Access Token
* An Access Token Secret * An Access Token Secret
You will also need to your *UserID* (or Owner ID) which is accessible from the same screen From here you're ready to go. You can post public tweets or simply create DMs through the use of the mode= variable. By default Direct Messaging (DM) is used.
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntaxes are as follows:
* **tweet**://**{userid}**@**{ConsumerKey}**/**{ConsumerSecret}**/**{AccessToken}**/**{AccessSecret}** * **twitter**://**{ConsumerKey}**/**{ConsumerSecret}**/**{AccessToken}**/**{AccessSecret}**
* **tweet**://**{ownerid}**@**{ConsumerKey}**/**{ConsumerSecret}**/**{AccessToken}**/**{AccessSecret}** * **twitter**://**{ScreenName}**@**{ConsumerKey}**/**{ConsumerSecret}**/**{AccessToken}**/**{AccessSecret}**
* **twitter**://**{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 tweet can be referenced like so:
* **twitter**://**{ConsumerKey}**/**{ConsumerSecret}**/**{AccessToken}**/**{AccessSecret}**?**mode=tweet**
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| ----------- | -------- | ----------- | ----------- | -------- | -----------
| userid | Yes | The UserID of your account such as *l2gnux* (if your id is @l2gnux). You must specify a {userid} *or* an {ownerid}. | ScreenName | Yes | The UserID of your account such as *l2gnux* (if your id is @l2gnux). You must specify a {userid} *or* an {ownerid}.
| owerid | Yes | The OwnerID can be retrieved from your Twitter App Configuration
| ConsumerKey | Yes | The Consumer Key | ConsumerKey | Yes | The Consumer Key
| ConsumerSecret | Yes | The Consumer Secret Key | ConsumerSecret | Yes | The Consumer Secret Key
| AccessToken | Yes | The Access Token; you would have had to generate this one from your Twitter App Configuration. | AccessToken | Yes | The Access Token; you would have had to generate this one from your Twitter App Configuration.
| AccessSecret | Yes | The Access Secret; you would have had to generate this one from your Twitter App Configuration. | AccessSecret | Yes | The Access Secret; you would have had to generate this one from your Twitter App Configuration.
| Mode | No | This the the Twitter 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**
#### Example #### Example
Send a slack notification to our channel #nuxref: Send a Twitter DM to @testaccount:
```bash ```bash
# Assuming our {ConsumerKey} is T1JJ3T3L2 # Assuming our {ConsumerKey} is T1JJ3T3L2
# Assuming our {ConsumerSecret} is A1BRTD4JD # Assuming our {ConsumerSecret} is A1BRTD4JD
# Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F # Assuming our {AccessToken} is TIiajkdnlazkcOXrIdevi7F
# Assuming our {AccessSecret} is FDVJaj4jcl8chG3 # Assuming our {AccessSecret} is FDVJaj4jcl8chG3
# our user is @testaccount # our user is @testaccount
apprise tweet://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3 apprise twitter://testaccount@T1JJ3T3L2/A1BRTD4JD/TIiajkdnlazkcOXrIdevi7F/FDVJaj4jcl8chG3
``` ```