使用釘釘建立企業內部機器人

福祿網路研發團隊發表於2021-11-09
機器人

目錄

玩轉釘釘機器人

前言：
釘釘的出現為企業節約了大量人力成本，其中也開放了大量的外部api介面方便企業使用。今天我們就來說說企業自研釘釘機器人的使用方法。請盡情食用

建立釘釘機器人：

如何建立釘釘機器人

登入釘釘開發者後臺，依次選擇應用開發 > 企業內部開發 > 機器人，點選建立應用。
20211102103251
20211102103324

這個時候，企業自己的機器人就建立好了。

如何呼叫機器人api

1、新增介面呼叫許可權。應用建立後預設只開放登入和訊息通知介面的呼叫許可權，您需要根據開發需要，新增對應的介面使用許可權。

2、獲取應用的access_token。access_token相當於是身份憑證。呼叫介面時，通過access_token來鑑權呼叫者身份。

20211102103745

下載官網的sdk包：
https://developers.dingtalk.com/document/app/download-the-server-side-sdk
機器人回撥所需要使用的apk
<dependency>
    <groupId>com.aliyun</groupId>
        <artifactId>dingtalk</artifactId>
    <version>1.1.84</version>
</dependency>

支援的訊息格式

text型別

{
    "at": {
        "atMobiles": [
            "180xxxxxx"
        ],
        "atUserIds": [
            "user123"
        ],
        "isAtAll": false
    },
    "text": {
        "content": "我就是我, @180xxxxxx 是不一樣的煙火"
    },
    "msgtype": "text"
}

20211102104614

markdown型別

{
     "msgtype": "markdown",
     "markdown": {
         "title":"杭州天氣",
         "text": "#### 杭州天氣 @150XXXXXXXX \n> 9度，西北風1級，空氣良89，相對溫度73%\n> ![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png)\n> ###### 10點20分發布 [天氣](https://www.dingalk.com) \n"
     },
      "at": {
          "atMobiles": [
              "150XXXXXXXX"
          ],
          "atUserIds": [
              "user123"
          ],
          "isAtAll": false
      }
 }

20211102104707

整體跳轉actionCard型別

{
    "msgtype": "actionCard",
    "actionCard": {
        "title": "打造一間咖啡廳", 
        "text": "![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png) \n #### 賈伯斯 20 年前想打造的蘋果咖啡廳 \n\n Apple Store 的設計正從原來滿滿的科技感走向生活化，而其生活化的走向其實可以追溯到 20 年前蘋果一個建立咖啡館的計劃",
        "singleTitle" : "閱讀全文",
        "singleURL" : "https://www.dingtalk.com/"
    }
}

20211102104746

feedCard型別

{
    "msgtype": "feedCard",
    "feedCard": {
        "links": [
            {
                "title": "時代的火車向前開1", 
                "messageURL": "https://www.dingtalk.com/", 
                "picURL": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"
            },
            {
                "title": "時代的火車向前開2", 
                "messageURL": "https://www.dingtalk.com/", 
                "picURL": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"
            }
        ]
    }
}

20211102104833

使用釘釘機器人推送訊息

 @PostMapping(value = "/robots")
    public String helloRobots(@RequestBody RobotResponse robotResponse
    ) throws Exception {
        String[] content = robotResponse.getText().getContent().split(" ");
        if (content.length == 2) {
            return dingtalkRobotTypeService.findByQuestion(content[0], content[1]);
        } else if (content.length == 1) {
            if (content[0].equals("公告")) {
                return RobotReplyService.feedCard(Arrays.asList(
                        new RobotFeedCard.FeedCardBean.LinksBean("時代的火車向前開1", "https://www.dingtalk.com/", "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"),
                        new RobotFeedCard.FeedCardBean.LinksBean("時代的火車向前開2", "https://www.dingtalk.com/", "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"),
                        new RobotFeedCard.FeedCardBean.LinksBean("時代的火車向前開2", "https://www.dingtalk.com/", "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png"),
                        new RobotFeedCard.FeedCardBean.LinksBean("時代的火車向前開2", "https://www.dingtalk.com/", "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png")));
            } else if (content[0].equals("活動")) {
                return RobotReplyService.aloneActionCard("你想參加這次活動", "![screenshot](https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png) \n>你就說你想不想參加活動吧\n>", 1, Arrays.asList(
                        new RobotAloneActionCard.ActionCardBean.BtnsBean("參加", "fsdfsdf"), new RobotAloneActionCard.ActionCardBean.BtnsBean("不想參加", "不想參加")));
            } else if (content[0].equals("測試")) {
                return RobotReplyService.markdown(null, "啦啦啦啦", "[啦啦啦啦](啦啦啦啦啦)");

            }
            return dingtalkRobotService.findByQuestion(content[0]);
        } else {
            return RobotReplyService.text(null, "不知道你想說啥");
        }
    }

機器人互動式卡片設計：

如何傳送互動式卡片

配置訊息模板

1、登入釘釘OA管理後臺。

2、進入釘釘可互動卡片搭建平臺，在搭建平臺上則可以看到當前組織內所建立的所有互動訊息模板。
20211102105214
3、單擊右上角的新增模板，然後輸入模板名稱，選擇卡片型別，最後單擊確認完成模板建立。
20211102105538

修改機器人互動卡片回撥地址

/**
     * 註冊回撥地址
     *
     * @throws BusinessException
     * @throws ApiException
     */
    public static OapiImChatScencegroupInteractivecardCallbackRegisterResponse registerURL(String url) throws Exception {
        DingTalkClient client = new DefaultDingTalkClient(O_API + "top/im/chat/scencegroup/interactivecard/callback/register");
        RobotCallBack req = new RobotCallBack();
        req.setCallbackUrl(url + "/robot/callback");
        req.setApiSecret("bgRtxxxx");
        req.setForceUpdate("true");
        OapiImChatScencegroupInteractivecardCallbackRegisterResponse rsp = client.execute(req, AccessTokenUtil.getAccessToken());
        return rsp;
    }

傳送機器人互動訊息

/**
     * 機器人推送互動卡片
     *
     * @param cardId
     * @param phone
     * @param cardData
     * @throws Exception
     */
    public static void sendCardMsg(String cardId, String phone, Map<String, String> cardData) throws Exception {
        String userId = getUserIdByMobile(phone);
        com.aliyun.dingtalkim_1_0.Client client = new com.aliyun.dingtalkim_1_0.Client(AccessTokenUtil.getHttpConfig());
        SendInteractiveCardHeaders sendInteractiveCardHeaders = new SendInteractiveCardHeaders();
        sendInteractiveCardHeaders.xAcsDingtalkAccessToken = AccessTokenUtil.getAccessToken();
        SendInteractiveCardRequest sendInteractiveCardRequest = new SendInteractiveCardRequest()
                .setCardTemplateId(cardId)
                .setReceiverUserIdList(Collections.singletonList(userId))
                .setOutTrackId(IdUtil.simpleUUID())
                .setCardData(new SendInteractiveCardRequest.SendInteractiveCardRequestCardData().setCardParamMap(cardData))
                .setOpenConversationId("cidJeCuP2boERqlkwy0rv4qHg")
                .setConversationType(1);
        try {
            client.sendInteractiveCardWithOptions(sendInteractiveCardRequest, sendInteractiveCardHeaders, new RuntimeOptions());
        } catch (TeaException err) {
            log.error(JSON.toJSONString(err.getData()));
        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            log.error(JSON.toJSONString(err.getData()));
        }
    }

20211102105837

接受互動卡片回撥訊息

 /**
     * 釘釘機器人觸發回撥事件
     *
     * @param tractId
     * @param cardData
     * @throws Exception
     */
    public static void updateCardMsg(String tractId, Map<String, String> cardData) throws Exception {
        com.aliyun.dingtalkim_1_0.Client client = new com.aliyun.dingtalkim_1_0.Client(AccessTokenUtil.getHttpConfig());
        UpdateInteractiveCardHeaders updateInteractiveCardHeaders = new UpdateInteractiveCardHeaders();
        updateInteractiveCardHeaders.xAcsDingtalkAccessToken = AccessTokenUtil.getAccessToken();
        UpdateInteractiveCardRequest updateInteractiveCardRequest = new UpdateInteractiveCardRequest()
                .setOutTrackId(tractId)
                .setCardData(new UpdateInteractiveCardRequest.UpdateInteractiveCardRequestCardData()
                        .setCardParamMap(cardData))
                .setUserIdType(1);
        try {
            UpdateInteractiveCardResponse updateInteractiveCardResponse = client.updateInteractiveCardWithOptions(updateInteractiveCardRequest, updateInteractiveCardHeaders, new RuntimeOptions());
            log.info(JSONObject.toJSONString(updateInteractiveCardResponse));
        } catch (TeaException err) {
            log.error(JSON.toJSONString(err.getData()));
        } catch (Exception _err) {
            TeaException err = new TeaException(_err.getMessage(), _err);
            log.error(JSON.toJSONString(err.getData()));
        }
    }

20211102110015

這個時候 我們就可以按照自己的需求來開發相應業務邏輯了

文章參考：釘釘開發展中心

福祿·研發中心 福小雄

相關文章