友達の拒否

Prev Next

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

他ユーザーから送られた友達リクエストを拒否します。

リクエスト

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

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

リクエストヘッダ

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/reject' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
        "userId": "a1c4aaa2-02f6-40bd-afb4-xxxxxxx",
        "friendId": "80803902-8b83-4860-b8a6-xxxxxx"
}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
     "friendship": {
                "project_id": "ec8231b2-6b20-4ad1-9c59-xxxxxx",
                "id": "5fe78d95-6186-4128-b52a-xxxxxxxxx",
                "status": "rejected",
                "user_id" : "xxxxxxxxxx",
                "user": {
                        "id": "xxxxxxxxxx",
                        "nickname": "xxxxxxxxxx"
                },
                "friend_id" : "xxxxxxxx",
                "friend": {
                        "id": "xxxxxxxxxx",
                        "nickname": "xxxxxxxxxx"
                },
                "friend_id": "80803902-8b83-4860-b8a6-xxxxxxxxx",
                "created_at": "2023-01-31T16:13:26-08:00",
                "updated_at": "2023-01-31T16:13:26-08:00",
                "requested_at": "2023-01-31T16:13:26-08:00"
        }
}