yii2-dingtalk 釘釘群機器人

alex丶sun發表於2019-02-16
機器人

說明

群機器人是釘釘群的高階擴充套件功能。群機器人可以將第三方服務的資訊聚合到群聊中，實現自動化的資訊同步。目前，大部分機器人在新增後，還需要進行Webhook配置，才可正常使用(配置說明詳見操作流程中的幫助連結)。

例如：通過聚合GitHub，GitLab等原始碼管理服務，實現原始碼更新同步。通過聚合Trello，JIRA等專案協調服務，實現專案資訊同步。

另外，群機器人支援Webhook協議的自定義接入，支援更多可能性，例如：你可將運維報警通過自定義機器人聚合到釘釘群實現提醒功能。

安裝

$ composer require saviorlv/yii2-dingtalk -vvv

配置

在使用本擴充套件之前，你需要去 群機器人 獲取相關資訊。

使用

在config/main.php配置檔案中定義component配置資訊

`components` => [
  .....
  `robot` => [
      `class` => `SaviorlvDingtalkRobot`,
      `accessToken` => `xxxxxxxxx`
    ],
  ....
]

傳送 Text 資訊

方法：

public function sendTextMsg($content, array $atMobiles = [], $isAtAll = false){}

引數：

引數 引數型別 必須 說明
content String 是 訊息內容
atMobiles Array 否 被@人的手機號
isAtAll bool 否 @所有人時：true，否則為：false

例項：

$response = Yii::$app->robot->sendTextMsg(
    "必要忘記上下班打卡",
    [
        136*****134,
        136*****132
    ],
    false
);

傳送 Link 連結

方法：

public function sendLinkMsg($title, $text, $picUrl = ``, $messageUrl){}

引數：

引數 引數型別 必須 說明
title String 是 訊息標題
text String 是 訊息內容。如果太長只會部分展示
messageUrl String 是 點選訊息跳轉的URL
picUrl String 否 圖片URL

例項：

$response = Yii::$app->robot->sendLinkMsg(
    "上下班打卡",
    "有些同志上下班就是不打卡，QAQ",
    "https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1536321778370&di=46a7abc85f6fe1de8df8fbdc5b95d68d&imgtype=0&src=http%3A%2F%2Fimg4.duitang.com%2Fuploads%2Fitem%2F201407%2F21%2F20140721224026_KU3GA.thumb.700_0.jpeg",
    "https://github.com/saviorlv?tab=repositories"
);

傳送 MarkDown 訊息

方法：

public function sendMarkdownMsg($title, $content, array $atMobiles = [], $isAtAll = false){}

引數：

引數 必選 型別 說明
title true string 首屏會話透出的展示內容
content true string markdown格式的訊息
atMobiles Array 否 被@人的手機號(在text內容裡要有@手機號)
isAtAll bool 否 @所有人時：true，否則為：false

例項：

$response = Yii::$app->robot->sendMarkdownMsg(
        "上下班打卡",
        " ###有些同志上下班就是不打卡，`QAQ`",
        [
            136*****134,
            136*****132
        ],
        false
    );

整體跳轉 ActionCard型別

方法：

public function sendActionCardMsg($title, $content, $singleURL, $hideAvatar = 0, $btnOrientation = 0, $singleTitle = `閱讀原文`){}

引數：

引數 必選 型別 說明
title true string 首屏會話透出的展示內容
content true string markdown格式的訊息
singleTitle true string 單個按鈕的方案。(設定此項和singleURL後btns無效)
singleURL true string 點選singleTitle按鈕觸發的URL
btnOrientation false string 0-按鈕豎直排列，1-按鈕橫向排列
hideAvatar false string 0-正常發訊息者頭像，1-隱藏發訊息者頭像

例項：

$response = Yii::$app->robot->sendActionCardMsg(
        "上下班打卡",
        " 有些同志上下班就是不打卡，QAQ",
        "https://github.com/saviorlv?tab=repositories",
        0,
        0,
        "你看不看"
    );

獨立跳轉 ActionCard 型別

方法：

public function sendSingleActionCardMsg($title, $content, $hideAvatar = 0, $btnOrientation = 0, array $btns=[]){}

引數：

引數 必選 型別 說明
title true string 首屏會話透出的展示內容
content true string markdown格式的訊息
btns true array 按鈕的資訊：title-按鈕方案，actionURL-點選按鈕觸發的URL
btnOrientation false string 0-按鈕豎直排列，1-按鈕橫向排列
hideAvatar false string 0-正常發訊息者頭像，1-隱藏發訊息者頭像

例項：

$response = Yii::$app->robot->sendSingleActionCardMsg(
            "上下班打卡",
            " 有些同志上下班就是不打卡，QAQ",
            0,
            1,
            [
                [
                    "title"=> "內容不錯", 
                    "actionURL"=> "https://www.dingtalk.com/"
                ], 
                [
                    "title"=> "不感興趣", 
                    "actionURL"=> "https://www.dingtalk.com/"
                ]
            ]
        );

FeedCard 型別

方法：

public function sendFeedCardMsg(array $links=[]){}

引數：

引數 必選 型別 說明
title true string 單條資訊文字
messageURL true string 點選單條資訊到跳轉連結
picURL true string 單條資訊後面圖片的URL

例項：

  $response = Yii::$app->robot->sendFeedCardMsg([
                [
                    "title"=> "時代的火車向前開",
                    "messageURL"=> "https://mp.weixin.qq.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI",
                    "picURL"=> "http://b.hiphotos.baidu.com/image/pic/item/f603918fa0ec08fa98d87c8054ee3d6d55fbda39.jpg"
                ],[
                    "title"=> "時代的火車向前開",
                    "messageURL"=> "https://mp.weixin.qq.com/s?__biz=MzA4NjMwMTA2Ng==&mid=2650316842&idx=1&sn=60da3ea2b29f1dcc43a7c8e4a7c97a16&scene=2&srcid=09189AnRJEdIiWVaKltFzNTw&from=timeline&isappinstalled=0&key=&ascene=2&uin=&devicetype=android-23&version=26031933&nettype=WIFI",
                    "picURL"=> "http://b.hiphotos.baidu.com/image/pic/item/f603918fa0ec08fa98d87c8054ee3d6d55fbda39.jpg"
                ],
        ]);

參考

相關文章