メッセージタイプとデータ形式

本記事では、API および Webhook を通じてボットメッセージを送信する際のメッセージタイプとデータ形式について説明します。

​

メッセージタイプとデータ形式

ボットメッセージを送信する方法には、API 経由で送信する方法と、Webhook 経由で送信する方法の 2 つがあります。方法によってサポートされるメッセージタイプとデータ形式が異なります。 注意 API 経由でのメッセージ送信をお勧めします。

​

API がサポートするメッセージタイプとデータ形式

​

対応 API

• ダイレクトメッセージを一括送信する
• 社内ボットが内部グループにメッセージを送信する

​

データ形式

​

Webhook がサポートするメッセージタイプとデータ形式

​

適用範囲

注意 Webhook はグループチャットでのみサポートされます。 Webhook を通じてメッセージを送信する方法の詳細については、内部ボットに Webhook を割り当ててグループチャットメッセージを送信するおよびカスタムボット統合を参照してください。

​

データ形式

• Text タイプ
  {
      "at": {
          "atMobiles": [
              "180xxxxxx"
          ],
          "atUserIds": [
              "user123"
          ],
          "isAtAll": false
      },
      "text": {
          "content": "私は私、@180xxxxxx 一味違う花火"
      },
      "msgtype": "text"
  }
  

  パラメータ	必須	タイプ	説明
  msgtype	はい	String	text。
  content	はい	String	メッセージテキスト。
  atMobiles	いいえ	Array	@メンションする人の携帯電話番号。 注意 メンションを有効にするには、上記の例のように、メッセージ内容に「@携帯電話番号」を含め、atMobiles パラメータと併用する必要があります。
  atUserIds	いいえ	Array	@メンションする人のユーザー ID。
  isAtAll	いいえ	Boolean	@全員にする場合は true、それ以外は false を設定します。

• Link タイプ
  {
      "msgtype": "link", 
      "link": {
          "text": "これは Link メッセージです", 
          "title": "これは Link メッセージです", 
          "picUrl": "https://img.alicdn.com/tfs/TB1NwmBEL9TBuNjy1zbXXXpepXa-2400-1218.png", 
          "messageUrl": "https://open.dingtalk.com/document/"
      }
  }
  

  パラメータ	パラメータタイプ	必須	説明
  msgtype	String	はい	メッセージタイプ。この場合は link で固定です。
  title	String	はい	メッセージタイトル。
  text	String	はい	メッセージ内容。長すぎる場合は一部のみ表示されます。
  messageUrl	String	はい	メッセージをクリックしたときに開く URL。
  picUrl	String	いいえ	画像 URL。

• Markdown タイプ
  {
       "msgtype": "markdown",
       "markdown": {
           "title":"杭州の天気",
           "text": "#### 杭州の天気 @150XXXXXXXX \n> 9 度、北西の風レベル 1、空気質良好 89、相対湿度 73% \n> \n> ###### 10:20 に公開 [天気](https://www.dingalk.com) \n"
       },
        "at": {
            "atMobiles": [
                "150XXXXXXXX"
            ],
            "atUserIds": [
                "user123"
            ],
            "isAtAll": false
        }
   }
  

  パラメータ	必須	タイプ	説明
  msgtype	はい	String	markdown。
  title	はい	String	チャットの最初の画面に表示される内容。
  text	はい	String	Markdown 形式のメッセージ内容。
  atMobiles	いいえ	Array	@メンションする人の携帯電話番号。 注意 メンションを有効にするには、上記の例のように、メッセージ内容に「@携帯電話番号」を含め、atMobiles パラメータと併用する必要があります。
  atUserIds	いいえ	Array	@メンションする人のユーザー ID。
  isAtAll	いいえ	Boolean	@全員にする場合は true、それ以外は false を設定します。

  現在、サポートされているのは Markdown 構文の一部のみです。サポートされる要素は以下のとおりです。
  タイトル
  # 見出し 1
  ## 見出し 2
  ### 見出し 3
  #### 見出し 4
  ##### 見出し 5
  ###### 見出し 6
   
  参照
  > A man who stands for nothing will fall for anything.
   
  太字と斜体テキスト
  **bold**
  *italic*
   
  リンク
  [this is a link](https://www.dingtalk.com/)
   
  画像
  
   
  箇条書き
  - item1
  - item2
   
  番号付きリスト
  1. item1
  2. item2
  
• カード全体ジャンプ ActionCard タイプ
  {
      "msgtype": "actionCard",
      "actionCard": {
          "title": "コーヒーショップを作る", 
          "text": " \n #### スティーブ・ジョブズが 20 年前に作りたかった Apple のコーヒーショップ \n\n Apple Store のデザインは、テクノロジー志向の強い雰囲気から、よりライフスタイル志向のものへと移行しつつあります。この方向性は、実際には Apple が 20 年前にコーヒーショップを作ろうとした計画にまで遡ることができます",
          "singleTitle" : "続きを読む",
          "singleURL" : "https://www.dingtalk.com/"
      }
  }
  

  パラメータ	必須	タイプ	説明
  msgtype	はい	String	actionCard。
  title	はい	String	チャットの最初の画面に表示される内容。
  text	はい	String	Markdown 形式のメッセージ内容。
  singleTitle	はい	String	単一ボタンのタイトル。
  singleURL	はい	String	単一ボタンのジャンプリンク。

• 独立ジャンプ ActionCard タイプ
  {
      "msgtype": "actionCard",
      "actionCard": {
          "title": "スティーブ・ジョブズが 20 年前に Apple のコーヒーショップを作りたかった、それが Apple Store の先駆けとなった", 
          "text": " \n\n #### スティーブ・ジョブズが 20 年前に作りたかった Apple のコーヒーショップ \n\n Apple Store のデザインは、テクノロジー志向の強い雰囲気から、よりライフスタイル志向のものへと移行しつつあります。この方向性は、実際には Apple が 20 年前にコーヒーショップを作ろうとした計画にまで遡ることができます", 
          "btnOrientation": "0", 
          "btns": [
              {
                  "title": "素晴らしいコンテンツ", 
                  "actionURL": "https://www.dingtalk.com/"
              }, 
              {
                  "title": "興味なし", 
                  "actionURL": "https://www.dingtalk.com/"
              }
          ]
      }
  }
  

  パラメータ	必須	タイプ	説明
  msgtype	はい	String	actionCard。
  title	はい	String	チャットの最初の画面に表示される内容。
  text	はい	String	Markdown 形式のメッセージ内容。
  btns	はい	Array	ボタン。
  title	はい	String	ボタンタイトル。
  actionURL	はい	String	ボタンをクリックしたときにトリガーされる URL。
  btnOrientation	いいえ	String	ボタンの配置順序。 0：ボタンを縦に配置 1：ボタンを横に配置

• 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"
              }
          ]
      }
  }
  

  パラメータ	必須	タイプ	説明
  msgtype	はい	String	feedCard。
  title	はい	String	単一メッセージ項目のテキスト。
  messageURL	はい	String	単一メッセージ項目のジャンプリンク。
  picURL	はい	String	単一メッセージ項目の後に表示される画像の URL。

  グループ内でメッセージを返信したくない場合は、以下の返信形式を使用します。
  {
      "msgtype": "empty"
  }