Skip to main content

Client APIについて

Client APIは、セッショントークン認証を使用してクライアントアプリから呼び出すAPIです。 エンドユーザーがチャットアプリを利用する際の、メッセージ送信やチャンネル操作などに使用します。

主な用途

メッセージ操作

メッセージの送信・編集・削除、既読管理

チャンネル操作

チャンネルの作成・参加・退出、メンバー管理

リアクション

メッセージへのリアクション追加・削除

ユーザー情報

ユーザー一覧の取得、プロフィール確認

認証方式

Client APIでは、セッショントークン発行APIで取得したセッショントークンを使用します。
セッショントークンは、Server APIの「セッショントークン発行」エンドポイントで取得します。

セッショントークンの取得

  1. Server APIでユーザーを作成
  1. セッショントークンを発行
レスポンス:
  1. Client APIで使用
取得したtokenをAuthorizationヘッダーで使用します。

ベースURL

<application_id>は管理画面で作成したアプリケーションのIDに置き換えてください。

レスポンス形式

すべてのレスポンスはJSON形式で返されます。

成功レスポンス

エラーレスポンス

HTTPステータスコード

次のステップ

チャンネル操作

チャンネルの作成と管理

メッセージ送信

メッセージの投稿と管理

WebSocket接続

リアルタイム通信の実装

全体ドキュメント

Rheel Chat APIドキュメントトップへ