友達の一括リクエスト

Prev Next

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

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

リクエスト

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

メソッド URI
GET /v1/api/v1/api/friendship/bulk

リクエストヘッダ

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

リクエストボディ

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

フィールド タイプ 必須の有無 説明
userId String Required ユーザー ID
friendId String Required 友達 ID

リクエスト例

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

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

]'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "message": "Friends added successfully"
}