Created Notify_dingtalk (markdown)

master
Chris Caron 2021-08-11 20:46:03 -04:00
parent 721c91438e
commit 3f24991201
1 changed files with 38 additions and 0 deletions

38
Notify_dingtalk.md Normal file

@ -0,0 +1,38 @@
## DingTalk
* **Source**: https://www.dingtalk.com/
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 160 Characters per message
### Account Setup
To use DingTalk, you will need to acquire your _API Key_.
### Syntax
Valid syntax is as follows:
* `dingtalk://{ApiKey}/{ToPhoneNo}`
* `dingtalk://{ApiKey}/{ToPhoneNo1}/{ToPhoneNo2}/{ToPhoneNoN}`
* `dingtalk://{Secret}@{ApiKey}/{ToPhoneNo}`
* `dingtalk://{Secret}@{ApiKey}/{ToPhoneNo1}/{ToPhoneNo2}/{ToPhoneNoN}`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| ApiKey | Yes | The _API Key_ associated with your DingTalk account. This is available to you via the DingTalk Dashboard.
| ToPhoneNo | No | A phone number to send your notification to
| Secret | No | The optional secret key to associate with the message signing
#### Example
Send a DingTalk Notification as an SMS:
```bash
# Assuming our {APIKey} is gank339l7jk3cjaE
# Assuming our {ToPhoneNo} - is in the US somewhere making our country code +1
# - identifies as 1-123-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
dingtalk://gank339l7jk3cjaE/11235551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
dingtalk://gank339l7jk3cjaE/1-(123) 555-1223
```