> ## Documentation Index
> Fetch the complete documentation index at: https://help.dingtalk.io/llms.txt
> Use this file to discover all available pages before exploring further.

# メッセージ通知タイプ

> テキスト、画像、音声、ファイルメッセージを業務通知で送信する JSON 形式とパラメータです

本記事では、DingTalk のメッセージ通知タイプとデータ形式について説明します。

## DingTalk メッセージ通知タイプ

**業務通知メッセージ**：企業の業務通知チャット内で特定のマイクロアプリの名義で社員にプッシュされる通知メッセージです。例：誕生日のお祝い、入社リマインドなど。

## テキストメッセージ（text）

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "text",
    "text": {
        "content": "月例ミーティング通知"
    }
}
```

### パラメータ説明：

| 名前      | タイプ    | 必須 | 例          | 説明                               |
| ------- | ------ | -- | ---------- | -------------------------------- |
| msgtype | String | はい | text       | メッセージタイプ。テキストメッセージのタイプは text です。 |
| content | String | はい | 月例ミーティング通知 | メッセージ内容。500 文字以内を推奨します。          |

### メッセージサンプル：

## 画像メッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "image",
    "image": {
        "media_id": "@lADOADmaWMzazQKA"
    }
}
```

### パラメータ説明：

| 名前        | タイプ    | 必須 | 例                 | 説明                                                                                                                                                       |
| --------- | ------ | -- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| msgtype   | String | はい | image             | メッセージタイプ。画像メッセージのタイプは image です。                                                                                                                          |
| media\_id | String | はい | @lADOADmaWMzazQKA | メディアファイル mediaId。[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して mediaId パラメータ値を取得します。幅 600 ピクセル × 高さ 400 ピクセル、縦横比 3:2 を推奨します。 |

### メッセージサンプル：

## 音声メッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "voice",
    "voice": {
       "media_id": "@lADOADmaWMzazQKA",
       "duration": "10"
    }
}
```

### パラメータ説明：

| 名前        | タイプ    | 必須 | 例                 | 説明                                                                                          |
| --------- | ------ | -- | ----------------- | ------------------------------------------------------------------------------------------- |
| msgtype   | String | はい | voice             | メッセージタイプ。音声メッセージのタイプは voice です。                                                             |
| media\_id | String | はい | @lADOADmaWMzazQKA | メディアファイル ID。[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得します。 |
| duration  | String | はい | 50                | 60 未満の正の整数で、音声の長さを表します。                                                                     |

### メッセージサンプル：

## ファイルメッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "file",
    "file": {
       "media_id": "MEDIA_ID"
    }
}
```

### パラメータ説明：

| 名前        | タイプ    | 必須 | 例                 | 説明                                                                                                                  |
| --------- | ------ | -- | ----------------- | ------------------------------------------------------------------------------------------------------------------- |
| msgtype   | String | はい | file              | メッセージタイプ。ファイルメッセージのタイプは file です。                                                                                    |
| media\_id | String | はい | @lADOADmaWMzazQKA | メディアファイル ID。参照するメディアファイルは最大 10MB で、[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得できます。 |

### メッセージサンプル：

## リンクメッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "link",
    "link": {
        "messageUrl": "http://s.dingtalk.io/market/dingtalk/error_code.php",
        "picUrl":"@lALOACZwe2Rk",
        "title": "テスト",
        "text": "テスト"
    }
}
```

### パラメータ説明：

| 名前              | タイプ    | 必須 | 例                                        | 説明                                                                                                                                      |
| --------------- | ------ | -- | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| msgtype         | String | はい | link                                     | メッセージタイプ。リンクメッセージのタイプは link です。                                                                                                         |
| link.messageUrl | String | はい | [http://dingtalk.io](http://dingtalk.io) | メッセージクリック時のリンクアドレス。送信メッセージがミニプログラムの場合はミニプログラムへのリダイレクトリンクをサポートします。[メッセージリンク説明](/ja/open/development/message-link-description) を参照してください。 |
| link.picUrl     | String | はい | @lADOADmaWMzazQKA                        | [メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得します。                                                         |
| link.title      | String | はい | linkメッセージテスト                             | メッセージタイトル。100 文字以内を推奨します。                                                                                                               |
| link.text       | String | はい | メッセージ内容テスト                               | メッセージの説明。500 文字以内を推奨します。                                                                                                                |

### メッセージサンプル：

## OA メッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
     "msgtype": "oa",
     "oa": {
        "message_url": "http://dingtalk.io",
        "head": {
            "bgcolor": "FFBBBBBB",
            "text": "ヘッダータイトル"
        },
        "body": {
            "title": "本文タイトル",
            "form": [
                {
                    "key": "名前:",
                    "value": "山田太郎"
                },
                {
                    "key": "年齢:",
                    "value": "20"
                },
                {
                    "key": "身長:",
                    "value": "1.8メートル"
                },
                {
                    "key": "体重:",
                    "value": "65キロ"
                },
                {
                    "key": "学歴:",
                    "value": "学士"
                },
                {
                    "key": "趣味:",
                    "value": "球技、音楽鑑賞"
                }
            ],
            "rich": {
                "num": "15.6",
                "unit": "円"
            },
            "content": "長文テキスト長文テキスト長文テキスト長文テキスト長文テキスト長文テキスト",
            "image": "@lADOADmaWMzazQKA",
            "file_count": "3",
            "author": "佐藤花子"
        }
    }
}
```

### パラメータ説明：

| 名前      | タイプ    | 必須 | 例  | 説明                            |
| ------- | ------ | -- | -- | ----------------------------- |
| msgtype | String | はい | oa | メッセージタイプ。OA メッセージのタイプは oa です。 |

### OA メッセージ本体パラメータ：

| 名前                           | タイプ                 | 必須  | 例                                        | 説明                                                                                                                                                         |
| ---------------------------- | ------------------- | --- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| oa.message\_url              | String              | はい  | [http://dingtalk.io](http://dingtalk.io) | メッセージクリック時のリンクアドレス。送信メッセージがミニプログラムの場合はミニプログラムへのリダイレクトリンクをサポートします。[メッセージリンク説明](/ja/open/development/message-link-description) を参照してください。                    |
| oa.pc\_message\_url          | String              | いいえ | [http://dingtalk.io](http://dingtalk.io) | PC 側でメッセージをクリックしたときのリダイレクト先アドレスです。                                                                                                                         |
| oa.head                      | JSON Object         | はい  |                                          | メッセージヘッダーコンテンツ。                                                                                                                                            |
| oa.head.bgcolor              | String              | はい  | FFBBBBBB                                 | メッセージヘッダータイトル内のフォントカラー。長さは半角 8 文字に制限されており、先頭 2 桁が透明度、後ろ 6 桁が色値を表します。0x は付けないでください。                                                                         |
| oa.head.text                 | String              | はい  | ヘッダータイトル                                 | メッセージのヘッダータイトル。[業務通知の送信](/ja/open/development/asynchronous-sending-of-enterprise-session-messages) メッセージの場合、このパラメータは現在のアプリ名に置き換わります。                       |
| oa.status\_bar               | JSON Object         | いいえ |                                          | メッセージステータスバー。受信者の userid リストのみをサポートし、userid は最大 5 人までです。  **説明**  部門 ID リストはサポートされず、to\_all\_user に true を渡すこともできません。                                      |
| oa.status\_bar.status\_value | String              | いいえ | 進行中                                      | ステータスバーのテキスト。                                                                                                                                              |
| oa.status\_bar.status\_bg    | String              | いいえ | 0xFFF65E5E                               | ステータスバーの背景色。デフォルトは黒色で、0xFF + 6 桁の色値を推奨します。                                                                                                                 |
| oa.body                      | JSON Object         | はい  |                                          | メッセージ本体。                                                                                                                                                   |
| oa.body.title                | String              | いいえ | 本文タイトル                                   | メッセージ本体のタイトル。50 文字以内を推奨します。                                                                                                                                |
| oa.body.form                 | Array\[JSON Object] | いいえ |                                          | メッセージ本体のフォーム。最大 6 件まで表示され、超過分は非表示になります。                                                                                                                    |
| oa.body.form.key             | String              | いいえ | 名前                                       | メッセージ本体のキーワード。                                                                                                                                             |
| oa.body.form.value           | String              | いいえ | 山田太郎                                     | メッセージ本体のキーワードに対応する値。                                                                                                                                       |
| oa.body.rich                 | JSON Object         | いいえ |                                          | 1 行のリッチテキスト情報。                                                                                                                                             |
| oa.body.rich.num             | String              | いいえ | 15.6                                     | 1 行のリッチテキスト情報の数値。                                                                                                                                          |
| oa.body.rich.unit            | String              | いいえ | 円                                        | 1 行のリッチテキスト情報の単位。                                                                                                                                          |
| oa.body.content              | String              | いいえ | 長文テキスト                                   | メッセージ本体の内容。最大 3 行まで表示されます。                                                                                                                                 |
| oa.body.image                | String              | いいえ | @lADOADmaWMzazQKA                        | メッセージ本体内の画像。画像リソース @mediaId をサポートし、[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得します。幅 600 ピクセル × 高さ 400 ピクセル、縦横比 3:2 を推奨します。 |
| oa.body.file\_count          | String              | いいえ | 3                                        | カスタムの添付ファイル数。この数値は表示用のみで、DingTalk では検証しません。                                                                                                                |
| oa.body.author               | String              | いいえ | 佐藤花子                                     | カスタムの作成者名。                                                                                                                                                 |

### メッセージサンプル：

## Markdown メッセージ

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
    "msgtype": "markdown",
    "markdown": {
        "title": "ファーストスクリーンのチャットで表示されるコンテンツ",
        "text": "# これは markdown をサポートするテキストです   \n   ## 見出し2    \n   * リスト1   \n  "
    }
}
```

### Markdown 構文の説明は以下のとおりです：

```text theme={"theme":{"light":"github-light","dark":"github-dark"}}
見出し
# 一級見出し
## 二級見出し
### 三級見出し
#### 四級見出し
##### 五級見出し
###### 六級見出し
 
参照
> A man who stands for nothing will fall for anything.
 
文字の太字、斜体
**bold**
*italic*
 
リンク
[this is a link](http://name.com)
 
画像

 
箇条書き
- item1
- item2
 
番号付きリスト
1. item1
2. item2

改行
  \n  （\n の前後にそれぞれ半角スペース2個を入れることを推奨）
```

### パラメータ説明：

| 名前      | タイプ    | 必須 | 例        | 説明                                                                                                                 |
| ------- | ------ | -- | -------- | ------------------------------------------------------------------------------------------------------------------ |
| msgtype | String | はい | markdown | メッセージタイプ。[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得します。Markdown タイプは markdown です。 |
| title   | String | はい | テストタイトル  | ファーストスクリーンのチャットで表示されるコンテンツ。iShot2022-07-14\_09                                                                     |
| text    | String | はい | テスト内容    | Markdown 形式のメッセージ。最大 5000 文字までです。                                                                                  |

### メッセージサンプル：

## カードメッセージ

カードメッセージは、全体リダイレクト ActionCard スタイルと独立リダイレクト ActionCard スタイルをサポートします。

* 全体リダイレクト ActionCard スタイルは、1 つのクリック Action をサポートし、パラメータ single\_title と single\_url の指定が必須です。

  ```json lines theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
      "msgtype": "action_card",
      "action_card": {
          "title": "チャットリストと通知に表示されるテキスト",
          "markdown": "markdown形式に対応した本文内容",
          "single_title": "詳細を見る",
          "single_url": "https://open.dingtalk.com"
      }
  }
  ```
* 独立リダイレクト ActionCard スタイルは、複数のクリック Action をサポートし、パラメータ btn\_orientation と btn\_json\_list の指定が必須です。

  ```json lines theme={"theme":{"light":"github-light","dark":"github-dark"}}
  {
      "msgtype": "action_card",
      "action_card": {
          "title": "チャットリストと通知に表示されるテキスト",
          "markdown": "markdown形式に対応した本文内容",
          "btn_orientation": "1",
          "btn_json_list": [
              {
                  "title": "ボタン1",
                  "action_url": "https://www.taobao.com"
              },
              {
                  "title": "ボタン2",
                  "action_url": "https://www.tmall.com"
              }
          ]
      }
  }
  ```

### パラメータ説明：

| 名前                                       | タイプ       | 必須  | 例                                                      | 説明                                                                                                                                                                          |
| ---------------------------------------- | --------- | --- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| msgtype                                  | String    | はい  | action\_card                                           | メッセージタイプ。カードメッセージのタイプは action\_card です。                                                                                                                                     |
| action\_card.markdown                    | String    | はい  | markdown形式に対応した本文内容                                    | メッセージ内容。Markdown をサポートし、構文は標準 Markdown 構文を参照してください。1000 文字以内を推奨します。                                                                                                         |
| action\_card.title                       | String    | いいえ | テストタイトル                                                | チャットリストと通知に表示されるテキスト。222                                                                                                                                                    |
| action\_card.single\_title               | String    | いいえ | 詳細を見る                                                  | 全体リダイレクト ActionCard スタイルを使用する際のタイトル。single\_url と同時に設定する必要があり、最長 20 文字です。  **説明**  全体リダイレクトの ActionCard スタイルの場合、**single\_title** と **single\_url** は必ず設定してください。            |
| action\_card.single\_url                 | String    | いいえ | [https://open.dingtalk.com](https://open.dingtalk.com) | メッセージクリック時のリンクアドレス。[メディアファイルのアップロード](/ja/open/development/upload-media-files) インターフェースを呼び出して取得します。送信メッセージがミニプログラムの場合はミニプログラムへのリダイレクトリンクをサポートし、最長 500 文字です。                  |
| action\_card.btn\_orientation            | String    | いいえ | 0                                                      | 独立リダイレクト ActionCard スタイルを使用する際のボタン配置方式：   - **0**：縦並び - **1**：横並び  btn\_json\_list と同時に設定する必要があります。                                                                         |
| action\_card.btn\_json\_list             | JSONArray | いいえ |                                                        | 独立リダイレクト ActionCard スタイルを使用する際のボタンリスト。btn\_orientation と同時に設定する必要があり、長さは 1000 文字以内です。  **説明**  独立リダイレクトの ActionCard スタイルの場合、btn\_json\_list と btn\_orientation は必ず設定してください。 |
| action\_card.btn\_json\_list.title       | String    | いいえ | ボタン2                                                   | 独立リダイレクト ActionCard スタイルを使用する際のボタンのタイトル。最長 20 文字です。                                                                                                                         |
| action\_card.btn\_json\_list.action\_url | String    | いいえ | [https://www.tmall.com](https://www.tmall.com)         | 独立リダイレクト ActionCard スタイルを使用する際のリダイレクトリンク。最長 700 文字です。                                                                                                                       |

### メッセージサンプル：

* 全体リダイレクト ActionCard タイプのメッセージで送信されるメッセージスタイルは以下のとおりです。

* 独立リダイレクト ActionCard タイプのメッセージで送信されるメッセージスタイルは以下のとおりです。
