Ncloud Chatの概要

Prev Next

Classic/VPC環境で利用できます。

Ncloud Chatは、リアルタイムチャットとメッセージシステム、複数のユーザーが参加するチャットチャンネルを実装できる NAVERクラウドプラットフォームのサービスです。Ncloud Chatサービスは、購読、ユーザー、チャンネル、メッセージ、友達、トークン機能関連の APIを RESTful形式で提供します。

API権限の設定

Ncloud Chat APIを使用するには、アクセス権限の設定が必要です。
Ncloud Chatダッシュボードの 設定 > セキュリティ で、APIアクセス権限設定を Read/Write 状態にして保存してください。

参考

Ncloud Chatダッシュボードは、NAVERクラウドプラットフォームコンソールで Services > Business Applications > Ncloud Chat メニューに移動し、プロジェクトリストから管理ページ URLをクリックするとアクセスできます。

Ncloud Chatの共通設定

Ncloud Chat APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://dashboard-api.ncloudchat.naverncp.com

リクエストヘッダ

リクエストヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-api-key Required Ncloud Chat用 APIキー
  • Ncloud Chatダッシュボードの 設定 > 一般 で、APIキーを確認
    • [APIキーを再作成] ボタンをクリックするとキーが再発行され、以前のキーは使用不可
x-project-id Required Ncloud Chatプロジェクト ID
  • Ncloud Chatダッシュボードの 設定 > 一般 からプロジェクト IDを確認

レスポンス

共通レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

Error
Errorは API呼び出し失敗情報を定義します。Errorの説明は次の通りです。

フィールド タイプ 必須の有無 説明
status Integer - レスポンスコード
message String - エラーメッセージ

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
- 1 - レスポンス成功
- -1 -
  • 登録されていない APIキー入力
  • アクセス権限なし
    		•
    - -2 - ダッシュボードの APIキーとヘッダに入力した APIキーが一致しない
    - -3 - 削除された APIキー
    - -4 - ダッシュボードで未使用処理された APIキー
    - -5 - 期限切れの APIキー
    - -6 - プロジェクト IDが存在しない
    参考

    NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

    レスポンス例

    呼び出しが成功した場合のレスポンス例は、API仕様書を確認してください。呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。

    {
    "status": -1,
    "message": "projectId is empty"
}

    Ncloud Chat API

    Ncloud Chatが提供する APIの説明は次の通りです。

    トークン

    トークン関連 APIの説明は次の通りです。

    API 説明
    トークンの発行 認証トークンを発行

    ユーザー

    ユーザー関連 APIの説明は次の通りです。

    API 説明
    ユーザーの登録 ユーザーを登録
    ユーザーリストの照会 ユーザーリストを照会
    ユーザーの照会 ユーザーの詳細情報を照会
    ユーザー情報の更新 ユーザー情報を更新
    ユーザーの退会 ユーザーの退会
    プッシュ通知の設定 ユーザーにプッシュ通知を設定
    プッシュ通知設定の照会 ユーザーのプッシュ通知設定履歴を照会
    プッシュ通知設定の解除 ユーザーのプッシュ通知設定を解除

    友達

    友達関連 APIの説明は次の通りです。

    API 説明
    友達のリクエスト 友達リクエストを送信
    友達の一括リクエスト 複数の友達リクエストを一括送信
    友達の拒否 友達リクエストを拒否
    友達の受諾 友達リクエストを承諾

    メッセージ

    メッセージ関連 APIの説明は次の通りです。

    API 説明
    メッセージの送信 メッセージを送信
    メッセージリストの照会 メッセージリストを照会
    メッセージの照会 メッセージの詳細情報を照会
    メッセージの削除 メッセージを削除

    チャンネル

    チャンネル関連 APIの説明は次の通りです。

    API 説明
    チャンネルの作成 チャンネルを作成
    チャンネルリストの照会 チャンネルリストを照会
    チャンネルの照会 チャンネルの詳細情報を照会
    チャンネルの更新 チャンネル情報を更新
    チャンネルの削除 チャンネルを削除

    購読

    購読関連 APIの説明は次の通りです。

    API 説明
    チャンネル購読リストの照会 チャンネル購読履歴リストを照会

    Ncloud Chat関連リソース

    Ncloud Chat APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。