Developers

タイムライン投稿(Post)

タイムライン投稿の登録・取得・削除を行う機能を提供します。

投稿登録時には、お知らせ通知、メール通知、SP プッシュ通知などのオプション通知が可能です。
投稿取得では、投稿に対するコメントもあわせて取得されます。返信が指定された場合でも、その返信元の親投稿を基点として、スレッド全体が返却されます。

チャンネル内の投稿についてはチャンネルメンバーのみが閲覧・投稿・削除の権限を持ち、ログインユーザーがチャンネルメンバーでない場合はこれらの操作はできません。
システムユーザーはすべてのチャンネルにアクセスでき、チャンネル内投稿の閲覧・作成・削除を行うことが可能です。

投稿の取得

必要な権限

タイムライン参照

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/post/{id}

HTTP Method

GET

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2id○string-投稿ID

Response

No.プロパティ名項目名タイプ備考
1id投稿IDnumber
2postDatetime投稿日時string
3body本文array(object)bodyの仕様について
4attachedFile添付ファイルarray(object)添付ファイルについて
5postUserId投稿ユーザー IDnumber
6postEmployeeId投稿社員 IDnumber
7tagタグarray(string)relation による自動タグ付与参照について
8relation紐づきアプリarray(object)relationについて
9channelチャンネルobjectチャンネルを紐づける設定を取得可能
- channelIdチャンネル IDnumber
- channelNameチャンネル名string
10repliesコメントarray(object)投稿に対するコメントが存在する場合、全てのコメントを取得　
各コメントの構造は投稿と同じ
- ...子項目は No.1 ～ 9 と同様。

Example

{
  "id": 47426210431851,
  "body": [
    {
      "behaviourType": "mention",
      "content": {
        "mentionType": "employee",
        "entityId": 14852199178487,
        "entityName": "山本 直樹"
      }
    },
    {
      "behaviourType": "text",
      "content": {
        "text": "さんこんにちは。"
      }
    },
    {
      "behaviourType": "image",
      "content": {
        "fileid": "f006faa4f894431a947d0e87c88f16ce",
        "filename": "画像.png"
      }
    },
    {
      "behaviourType": "url",
      "content": {
        "url": "https://www.google.co.jp/",
        "displayText": "bodyの書き方"
      }
    }
  ],
  "attachedFile": [
    {
      "fileid": "92bab51732e74430b75b3babb6836853",
      "filename": "添付ファイル.pptx"
    },
    {
      "fileid": "f006faa4f894431a947d0e87c88f16ce",
      "filename": "画像.png"
    }
  ],
  "postDatetime": "2025/02/14 12:52",
  "postUserId": "200",
  "postEmployeeId": "300",
  "tag": [
    "#customer",
    "#manual_post" //APIを使用して投稿を作成すると、#manual_postタグが自動的に追加されます。
  ],
  "channel": {
    "id": 47426210431152,
    "name": "APIチャンネル123"
  },
  "relation": [
    {
      "sheetName": "customer",
      "entityId": 14852199178487,
      "entityName": "佐藤 健一"
    }
  ],
  "replies": [
    {
      "id": 47426210431853,
      "body": [
        {
          "behaviourType": "mention",
          "content": {
            "type": "employee",
            "entityId": 14852199178487,
            "entityName": "高橋 悠斗"
          }
        },
        {
          "behaviourType": "text",
          "content": {
            "text": "さんこんにちは。"
          }
        },
        {
          "behaviourType": "image",
          "content": {
            "fileid": "f006faa4f894431a947d0e87c88f16ce",
            "filename": "画像.png"
          }
        },
        {
          "behaviourType": "url",
          "content": {
            "url": "https://www.google.co.jp/",
            "displayText": "URLリンク"
          }
        }
      ],
      "attachedFile": [
        {
          "fileid": "92bab51732e74430b75b3babb6836853",
          "filename": "資料.pdf"
        },
        {
          "fileid": "f006faa4f894431a947d0e87c88f16ce",
          "filename": "画像.png"
        }
      ],
      "postDatetime": "2025/02/01 12:00",
      "postUserId": "200",
      "postEmployeeId": "400",
      "tag": [
        "#customer",
        "#manual_post" //APIを使用して投稿を作成すると、#manual_postタグが自動的に追加されます。
      ],
      "channel": {
        "id": 47426210431152,
        "name": "APIチャンネル"
      },
      "relation": [
        {
          "sheetName": "customer",
          "entityId": 14852199178487,
          "entityName": "A株式会社"
        }
      ]
    }
  ]
}

投稿の新規登録

必要な権限

タイムライン投稿

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/post

HTTP Method

POST

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
Request Body
No.プロパティ名必須項目名タイプ備考
1channelId投稿対象チャンネル IDnumber投稿先のチャンネルを指定
2parentPostId返信対象投稿IDnumber返信の場合、返信している投稿を指定する
3body本文array(object)body作成方法参照
4attachedFile添付ファイルarray(object)添付ファイルについて
5relation紐づきアプリarray(object)紐づきアプリ参照
6notificationOptionお知らせ通知指定object各種通知に関する設定。お知らせ通知/メール通知/SP プッシュ通知に関する設定を行うことが可能
- notificationPostお知らせ通知投稿object
-- bodyお知らせ通知投稿本文string通知されるお知らせ投稿の本文を指定
- mailメール通知object
-- subject件名string通知されるメールの件名を指定
-- bodyメール本文string通知されるメールの本文を指定
- spPushSP プッシュ通知object
-- bodyプッシュ通知本文stringプッシュ通知の本文を指定
- destination通知対象array(number)通知したい社員の ID を指定

Example

{
  "channelId": 47426210431152,
  "parentPostId": 47426210431782,
  "body": [
    {
      "behaviourType": "mention",
      "content": {
        "mentionType": "employee",
        "entityId": 14852199178487
      }
    },
    {
      "behaviourType": "text",
      "content": {
        "text": "/nさんこんにちは。/n"
      }
    },
    {
      "behaviourType": "image",
      "content": {
        "fileid": "f006faa4f894431a947d0e87c88f16ce"
      }
    },
    {
      "behaviourType": "url",
      "content": {
        "displayText": "URLリンク",
        "url": "https://www.google.co.jp/"
      }
    },
    {
      "behaviourType": "text",
      "content": {
        "text": "/n/n よろしくお願いします。/n"
      }
    }
  ],
  "attachedFile": [
    {
      "fileid": "92bab51732e74430b75b3babb6836853"
    }
  ],
  "relation": [
    {
      "sheetName": "customer",
      "entityId": 47593743386429
    }
  ],
  "notificationOption": {
    "notificationPost": {
      "body": "通知本文が書けます。"
    },
    "mail": {
      "subject": "メール件名です",
      "body": "メール本文です。"
    },
    "spPush": {
      "body": "PUSH通知内容が書けます。"
    },
    "destination": [14852199178487, 14852199179345]
  }
}

Response

Example

{
  "id": 47426210431783,
  "channelId": 47426210431152,
  "parentPostId": 47426210431782,
  "body": [
    {
      "behaviourType": "mention",
      "content": {
        "mentionType": "employee",
        "entityId": 14852199178487
      }
    },
    {
      "behaviourType": "text",
      "content": {
        "text": "/nさんこんにちは。/n"
      }
    },
    {
      "behaviourType": "image",
      "content": {
        "fileid": "f006faa4f894431a947d0e87c88f16ce"
      }
    },
    {
      "behaviourType": "url",
      "content": {
        "displayText": "URLリンク",
        "url": "https://www.google.co.jp/"
      }
    },
    {
      "behaviourType": "text",
      "content": {
        "text": "/n/n よろしくお願いします。/n"
      }
    }
  ],
  "attachedFile": [
    {
      "fileid": "92bab51732e74430b75b3babb6836853"
    }
  ],
  "relation": [
    {
      "sheetName": "customer",
      "entityId": 47593743386429,
      "entityName": "山本 直樹"
    }
  ],
  "tag": [
    "#customer",
    "#manual_post" //APIを使用して投稿を作成すると、#manual_postタグが自動的に追加されます。
  ],
  "notificationOption": {
    "notificationPost": {
      "body": "通知本文が書けます。"
    },
    "mail": {
      "subject": "メール件名です",
      "body": "メール本文です。"
    },
    "spPush": {
      "body": "PUSH通知内容が書けます。"
    },
    "destination": [14852199178487, 14852199179345]
  }
}

投稿の削除

投稿削除を実行すると、指定した投稿データが削除されます。
加えて、その投稿に対する全てのコメントも同時に削除されます。

必要な権限

タイムライン削除

Request

URL

https://gateway-esm.softbrain.com/esm-api/{tenant}/pub/esms/v1/post/{id}

HTTP Method

DELETE

Parameter

Path Parameter
No.パラメータ必須タイプデフォルト値説明
1tenant○string-会社ID
2id○string-投稿ID