yii2-dingtalk 釘釘羣機器人

說明

羣機器人是釘釘羣的高級擴展功能。羣機器人能夠將第三方服務的信息聚合到羣聊中,實現自動化的信息同步。目前,大部分機器人在添加後,還須要進行Webhook配置,纔可正常使用(配置說明詳見操做流程中的幫助連接)。

例如:經過聚合GitHub,GitLab等源碼管理服務,實現源碼更新同步。經過聚合Trello,JIRA等項目協調服務,實現項目信息同步。php

另外,羣機器人支持Webhook協議的自定義接入,支持更多可能性,例如:你可將運維報警經過自定義機器人聚合到釘釘羣實現提醒功能。android

安裝

$ composer require saviorlv/yii2-dingtalk -vvv

配置

在使用本擴展以前,你須要去 羣機器人 獲取相關信息。git

使用

在config/main.php配置文件中定義component配置信息
'components' => [
  .....
  'robot' => [
      'class' => 'Saviorlv\Dingtalk\Robot',
      'accessToken' => 'xxxxxxxxx'
    ],
  ....
]

發送 Text 信息

方法:github

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

參數:api

參數 參數類型 必須 說明
content String 消息內容
atMobiles Array 被@人的手機號
isAtAll bool @全部人時:true,不然爲:false

實例:yii2

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

發送 Link 連接

方法:markdown

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

參數:app

參數 參數類型 必須 說明
title String 消息標題
text String 消息內容。若是太長只會部分展現
messageUrl String 點擊消息跳轉的URL
picUrl String 圖片URL

實例:composer

$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"
                ],
        ]);

參考

相關文章
相關標籤/搜索