Skip to content

リクエストに利用するデータの取得方法

APIを利用するためにIDなどが必要になる場合があります。
ここにその取得方法を記載します。

ユーザーシステムIDの取得方法

ユーザーのシステムIDを利用するAPI

  • 一般ユーザーAPIのユーザー所属ルームメッセージ投稿API(メンション先の指定時)
  • システム管理者APIのシステム通知投稿系API
  • チャットボットAPIのチャットボット所属コンタクトメッセージ投稿API

手順

システムIDを取得したいユーザーとコンタクトを結んでいる場合
  1. システムIDを取得したいユーザーとのコンタクトを表示します。
  2. アドレスバーのURLのidパラメータの値がユーザーのシステムIDです。
    これを取得します。
    コンタクト表示時のアドレスバーの例:
    https://sample.domain/cgi-bin/chatlk/chat.cgi#action=user&id=1wkmq7kffobs
システムIDを取得したいユーザーとコンタクトを結んでいないが、所属しているルームは分かる場合

※ システム管理者権限のユーザーでのみ取得できます。

  1. システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
  2. 左側のメニューから「運用設定」の「ルーム管理」の「メンバーエクスポート」を選択して、
    メンバーエクスポート画面を表示します。
  3. 「エクスポート対象」の項目の「ルーム選択」から、該当ユーザーがメンバーに含まれているルームを選択します。
  4. 「エクスポート」を行い、ダウンロードした内容から該当ユーザーのシステムIDを取得します。
システムIDを取得したいユーザーとコンタクトを結んでおらず、所属しているルームも分からない場合

※ システム管理者権限のユーザーでのみ取得できます。

  1. システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
  2. 左側のメニューから「運用設定」の「ユーザー管理」の「エクスポート」を選択して、
    エクスポート画面を表示します。
  3. 「エクスポート」を行い、ダウンロードした内容から該当ユーザーのシステムIDを取得します。

ルームシステムIDの取得方法

ルームのシステムIDを利用するAPI

  • 一般ユーザーAPIのユーザー所属ルームメッセージ投稿API
  • システム管理者APIのルーム通知投稿API
  • チャットボットAPIのチャットボット所属ルームメッセージ投稿API

手順

システムIDを取得したいルームに所属している場合
  1. メッセージを投稿したいルームを表示します。
  2. 任意のメッセージのメッセージ/ホバーメニューの「その他」から「リンクをコピー」をクリックします。
    ※ 「リンクをコピー」をクリックすると、メッセージのリンクをコピーすることができます。
    詳しくは ユーザーズマニュアル の「中央タイムラインの機能 > チャット表示エリア > リンクをコピー」の項目をご覧ください。
  3. コピーしたリンクのidパラメータの値がルームのシステムIDです。
    これを取得します。
    コピーしたリンクの例:
    https://sample.domain/cgi-bin/chatlk/chat.cgi#action=room&id=1wkmq7ltrvo4&message_id=1z99h5c3g7fc
システムIDを取得したいルームに所属していない場合

※ システム管理者権限のユーザーでのみ取得できます。

  1. システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
  2. 左側のメニューから「運用設定」の「ルーム管理」の「ルームエクスポート」を選択して、
    ルームエクスポート画面を表示します。
  3. 「エクスポート」を行い、ダウンロードした内容から該当ルームのシステムIDを取得します。

組織システムIDの取得方法

組織システムIDを利用するAPI

  • システム管理者APIの全ユーザー一覧取得API(組織のシステムIDによる絞り込みの利用時)

手順

  1. システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
  2. 左側のメニューから「運用設定」の「組織管理」の「エクスポート」を選択して、
    エクスポート画面を表示します。
  3. 「エクスポート」を行い、ダウンロードした内容から該当組織のシステムIDを取得します。

メッセージのシステムIDの取得方法

メッセージのシステムIDを利用するAPI

  • コメント投稿時の一般ユーザーAPIのマイルームメッセージ投稿API
  • コメント投稿時の一般ユーザーAPIのユーザー所属ルームのメッセージ投稿API
  • コメント投稿時のチャットボットAPIのチャットボットマイルームメッセージ投稿API
  • コメント投稿時のチャットボットAPIのチャットボット所属ルームメッセージ投稿API
  • コメント投稿時のチャットボットAPIのチャットボット所属コンタクトメッセージ投稿API

手順

  1. コメントを投稿したいマイルーム/ルーム/コンタクトを表示します。
  2. コメントをしたいメッセージのメッセージ/ホバーメニューの「その他」から「リンクをコピー」をクリックします。
    ※ 「リンクをコピー」をクリックすると、メッセージのリンクをコピーすることができます。
    詳しくは ユーザーズマニュアル の「中央タイムラインの機能 > チャット表示エリア > リンクをコピー」の項目をご覧ください。
  3. コピーしたリンクのmessage_idパラメータの値がメッセージのシステムIDです。
    これを取得します。
    コピーしたリンクの例:
    https://sample.domain/cgi-bin/chatlk/chat.cgi#action=room&id=1wkmq7ltrvo4&message_id=1z99h5c3g7fc