友達のリクエスト

Prev Next

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

他ユーザーに友達リクエストを送信します。リクエストを受信したユーザーは、通知を介してリクエストの内容を確認できます。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /v1/api/friendship/request

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
userId String Required ユーザー ID
friendId String Required 友達 ID
message String Optional 友達リクエストメッセージ

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/request' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
            "userId": "guestID2",
            "friendId": "user_5",
            "message": "You are requested."
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
data.requestFriend.friendship Object - 友達リクエスト情報
data.requestFriend.friendship.project_id String - プロジェクト ID
data.requestFriend.friendship.id String - 固有 ID
data.requestFriend.friendship.status String - リクエストの進行状況
data.requestFriend.friendship.user_id String - ユーザー ID
data.requestFriend.friendship.user Object - ユーザー情報
data.requestFriend.friendship.user.id String - ユーザー ID
data.requestFriend.friendship.user.name String - ユーザーの名前
data.requestFriend.friendship.user.profile String - ユーザープロファイル画像
data.requestFriend.friendship.friend Object - 友達情報
data.requestFriend.friendship.friend.id String - 友達 ID
data.requestFriend.friendship.friend.name String - 友達名
data.requestFriend.friendship.friend.profile String - 友達プロファイル画像
data.requestFriend.friendship.friend_id String - 友達 ID
data.requestFriend.friendship.created_at String - 作成日時
  • ISO 8601形式
data.requestFriend.friendship.updated_at String - 情報更新日時
  • ISO 8601形式
data.requestFriend.friendship.requested_at String - 友達リクエスト日時
  • ISO 8601形式

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

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "data": {
        "requestFriend": {
            "friendship": {
                "project_id": "8be54b8b-*****-****-****-84c0d5df2e9c",
                "id": "58478769-****-****-****-8cff6c4a5d75",
                "status": "requested",
                "user_id": "d71157d7-****-****-****-3c4cd4fef46e",
                "user": {
                    "id": "TWVtYmVy****************************************ZDRmZWY0NmU=",
                    "name": "Admin",
                    "profile": ""
                },
                "friend": {
                    "id": "TWVt**********VyXzU=",
                    "name": "a",
                    "profile": ""
                },
                "friend_id": "user_5",
                "created_at": null,
                "updated_at": null,
                "requested_at": "2025-07-24T13:58:23+09:00"
            }
        }
    }
}