2024/10/24
校閲まち

【Chatwork API】Chatworkでチャットのメンバー一覧を取得する方法

A.I

目次

ChatworkのAPIを利用して、特定のチャットのメンバー一覧を取得する方法について紹介しています。本記事ではYoomというノーコードサービスを利用するので、プログラミングやAPIについて詳しくない方でも実現が可能です。

チャットのメンバー一覧を取得するAPIの仕様

公式仕様ではチャットのメンバー一覧を取得するAPIの仕様は以下のようになっています。このAPIを利用することで指定されたルームIDのメンバー一覧を取得でき、各メンバーのアカウント情報や役割などを含む詳細情報を取得することができるようです。

リクエスト仕様

  • HTTP メソッド: GET
  • リクエストURL: https://api.chatwork.com/v2/rooms/{room_id}/members

パラメータ

パラメータ名 種類 必須 説明
room_id パス 必須 integer (int64) 対象のチャットルームのID

room_id はURLパスに含めて指定する必要があります。


レスポンス仕様

  • ステータスコード: 200 OK(成功時)

レスポンスボディ

Content-Type: application/json

形式: 配列(array)形式でメンバーのオブジェクトを返します。

サンプルレスポンス

[
  {
    "account_id": 12345,
    "role": "member",
    "name": "John Doe",
    "chatwork_id": "johndoe",
    "organization_id": 1001,
    "organization_name": "ABC Corporation",
    "department": "Sales",
    "avatar_image_url": "https://example.com/avatar/johndoe.png"
  },
  {
    "account_id": 67890,
    "role": "admin",
    "name": "Jane Smith",
    "chatwork_id": "janesmith",
    "organization_id": 1002,
    "organization_name": "XYZ Inc.",
    "department": "HR",
    "avatar_image_url": "https://example.com/avatar/janesmith.png"
  }
]

レスポンスの詳細

フィールド名 説明
account_id integer メンバーのアカウントID
role string メンバーの役割(adminmember など)
name string メンバーの名前
chatwork_id string メンバーのChatwork ID
organization_id integer メンバーの所属する組織のID
organization_name string メンバーの所属する組織名
department string メンバーの部署名
avatar_image_url string メンバーのアバター画像のURL

チャットのメンバー一覧を取得するAPIをノーコードツールのYoomで実現

APIやプログラミングに詳しくない方でも利用が可能なノーコードツールのYoomを利用して、実際に上記で紹介したAPIを使ってチャットのメンバー一覧を取得する方法を紹介していきます。

はじめる前に

まず、Yoomアカウントをお持ちでない方は、Yoomのアカウント発行ページからアカウントを発行してください。30秒で始められます!

[Yoomとは]

Step1: チャットワークAPIを利用可能にする

1.Yoomにログイン後、左欄にある「マイアプリ」を選択し「+新規接続」を選択してください。

2.マイアプリの新規接続一覧の中から、今回使用する「Chatwork」を選択し、アプリを連携して下さい。アプリ名で検索も可能です。

3.Chatworkのアカウントを入力し、「サインイン」を選択します。

4.パスワードを入力し「ログイン」を選択すると、次の画面が表示されます。
  「許可」を選択してください。

5.マイアプリ連携が完了します。これでチャットワークAPIが利用可能になりました!

STEP2: チャットのメンバー一覧を取得するAPIをリクエストする

1, 「はじめから作成」を選択します。

2. 「プラスボタン」を押して、「アプリと連携する」を選択します。

3. チャットワークを選択しましょう

4. アカウントを選択した後、「チャットのメンバー一覧を取得」を選択します。

6. ルームIDを選択してテストを押しましょう。「テスト成功」と表示されればAPIリクエストが成功です!上記のAPI仕様と見比べてみると各項目の情報が取得できていることがわかりますね。

7. 「保存する」を押すとチャットのメンバー一覧を取得するAPIリクエストが一つのオペレーションとして定義されます。

このオペレーションから、さらにスプレッドシートやスラックなどのアプリをつなげることで、業務自体の自動化や効率化が実現できます。例えば、メンバー一覧を取得して、スプレッドシートに連携した後、退職者が入っていないかをスプレッドシート上で確認したりといったことができそうです。


Yoomにはこういった活用事例が「フローボットテンプレート」といって大量に用意されていますので、以下より自分の業務に利用ができそうなChatworkAPIを使った自動化を検討してみてはいかがでしょうか?

https://lp.yoom.fun/fb-template/all-templates?search=chatwork

この記事を書いた人
A.I
Yoomをつくった人です。
タグ
Chatwork
関連アプリ
Yoomのハイパーオートメーションとは?
従来のRPAでは単純な繰り返し作業しか自動化できず、その設定作業はとても複雑なものでした。
AI・API・RPA・OCRなど様々な技術を組み合わせた「ハイパーオートメーション」なら、これまでは実現できなかった多くの作業を、これまでよりも簡単に自動化することが可能です。
Yoomのハイパーオートメーションとは?
従来のRPAでは単純な繰り返し作業しか自動化できず、その設定作業はとても複雑なものでした。
AI・API・RPA・OCRなど様々な技術を組み合わせた「ハイパーオートメーション」なら、これまでは実現できなかった多くの作業を、これまでよりも簡単に自動化することが可能です。
Yoomについて詳しく見る
お役立ち資料
Yoomがわかる!資料3点セット
資料ダウンロード
3分でわかる!Yoomサービス紹介資料
資料ダウンロード
Before Afterでわかる!Yoom導入事例集
資料ダウンロード
お役立ち資料一覧を見る
会社概要
利用規約(JaEn
プライバシーポリシー(JaEn
セキュリティポリシー(JaEn
特定商取引法に基づく表記
©️ Yoom Inc.
Yoomとは?
これまでは実現できなかった多くの作業を、これまでよりも簡単に自動化することが可能です。
詳しくみる
詳しくみる