MENU
      Login
          Login
          目次 x
          友達
            目次

            友達

              記事の要約

              友達管理

              友達リクエスト

              他のユーザーに友達リクエストを送信します。受信者は、そのリクエストの通知を受け取ります。

              Request

              • Method : POST
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/request
              POST
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/request
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
data:
{
    "userId": "80803902-8b83-4860-b8a6-xxxxxxxx",
    "friendId": "a1c4aaa2-02f6-40bd-afb4-xxxxxxx",
    "message": "友達になりましょう!!"
}
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              userIdStringOユーザー ID
              friendIdStringO友達追加 ID
              messageStringXメッセージ

              Response

              成功

              {
   "friendship": {
        "project_id": "ec8231b2-6b20-4ad1-9c59-xxxxx",
        "id": "5fe78d95-6186-4128-b52a-28759cxxxxxx",
        "status": "requested",
        "user_id" : "xxxxxxxxxx",
        "user": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "friend_id" : "xxxxxxxx",
        "friend": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "friend_id": "a1c4aaa2-02f6-40bd-afb4-b1d6caacf0de",
        "requested_at": "2023-01-31T16:13:26-08:00"
    }
}
              JavaScript
              AttributeTypeDescription
              friendship.project_idStringプロジェクト ID
              friendship.idString入力 ID
              friendship.user_idStringユーザー ID
              friendship.statusString状態
              friendship.user_idStringID
              friendship.userObjectマイ情報
              friendship.friend_idString友達 ID
              friendship.friendObject友達情報
              friendship.requested_atStringリクエスト日

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容

              友達の承諾

              相手から送られてきた友達リクエストを承諾します。承諾後、2人のユーザーは友人になります。

              Request

              • Method : POST
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/accept
              POST
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/accept
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
data:
{
    "userId": "a1c4aaa2-02f6-40bd-afb4-xxxxxxxxx",
    "friendId": "80803902-8b83-4860-b8a6-xxxxxxx"
}
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              userIdStringOユーザー ID
              friendIdStringO友達追加 ID

              Response

              成功

              {
   "friendship": {
        "project_id": "ec8231b2-6b20-4ad1-9c59-xxxxxx",
        "id": "5fe78d95-6186-4128-b52a-xxxxxxxxx",
        "status": "accepted",
        "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"
    }
}
              JavaScript
              AttributeTypeDescription
              friendship.project_idStringプロジェクト ID
              friendship.idString入力 ID
              friendship.user_idStringユーザー ID
              friendship.statusString状態
              friendship.user_idStringID
              friendship.friend_idString友達 ID
              friendship.userObjectマイ情報
              friendship.friendObject友達情報
              friendship.requested_atStringリクエスト日

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容

              友達の拒否

              相手から送られてきた友達リクエストを拒否します。

              Request

              • Method : POST
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/reject
              POST
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship/reject
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
data:
{
     "userId": "a1c4aaa2-02f6-40bd-afb4-xxxxxxx",
    "friendId": "80803902-8b83-4860-b8a6-xxxxxx"
}
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              userIdStringOユーザー ID
              friendIdStringO友達追加 ID

              Response

              成功

              {
   "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"
    }
}
              JavaScript
              AttributeTypeDescription
              friendship.project_idStringプロジェクト ID
              friendship.idString入力 ID
              friendship.user_idStringID
              friendship.friend_idString友達 ID
              friendship.statusString状態
              friendship.userObjectマイ情報
              friendship.friendObject友達情報
              friendship.requested_atStringリクエスト日

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容

              友達の削除

              他のユーザーとの友達関係をやめることができる機能です。友達の削除は当事者の友人リストからそのユーザーを削除します。当事者が削除した友達と再び友達関係を結びたい場合は、新たに友達のリクエストを送信する必要があります。

              Request

              • Method : POST
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship
              DELETE
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendship
Header : 'content-type: application/json'
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
data:
{
     "userId": "80803902-8b83-4860-b8a6-xxxxxx",
    "friendId": "a1c4aaa2-02f6-40bd-afb4-xxxxxxx",
}
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              userIdStringOユーザー ID
              friendIdStringO友達追加 ID

              Response

              成功

              {
   "friendship": {
        "project_id": "ec8231b2-6b20-4ad1-9c59-xxxxxx",
        "id": "5fe78d95-6186-4128-b52a-xxxxxxxxx",
        "status": "deleted",
        "user_id" : "xxxxxxxxxx",
        "user": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "friend_id" : "xxxxxxxx",
        "friend": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "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"
    }
}
              JavaScript
              AttributeTypeDescription
              friendship.project_idStringプロジェクト ID
              friendship.idString入力 ID
              friendship.statusString状態
              friendship.user_idStringID
              friendship.friend_idString友達 ID
              friendship.userObjectマイ情報
              friendship.friendObject友達情報
              friendship.requested_atStringリクエスト日

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容

              友達リスト

              現在の友人のリストを表示します。

              Request

              • Method : GET
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/friendships?filter={"status":"accepted","user_id":"2d51cc68-a0d9-xxxxx-xxxx-xxxxxxxxxxxx"}
              POST
url : https://gamepot.apigw.ntruss.com/gpapps/v2/friendship?filter={"status":"accepted","user_id":"2d51cc68-a0d9-xxxxx-xxxx-xxxxxxxxxxxx"}
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              filterStringOクエリをフィルターすべてのフィールドに対して検索を有効にします。
              user_idStringOユーザー ID

              フィルターはコードによって様々な活用が可能です。
              statusコードにより友達のリストを検索できます。

              "accepted" : 友達の承諾をした友達のリスト
              "rejected" : 友達の承諾を拒否したリスト
              "requested" : 友達のリクエストをしたリスト
              "pending" : 友達のリクエストを受けたリスト

              Response

              成功

              [
    {
        "project_id": "ec8231b2-6b20-4ad1-9c59-8e183087a742",
        "id":"xxxxxxxxxxxxxxxxxxxx",
        "status": "accepted",
        "user_id" : "xxxxxxxxxx",
        "user": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "friend_id" : "xxxxxxxx",
        "friend": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "created_at": "2023-01-31T16:28:00-08:00",
        "updated_at": "2023-01-31T16:28:03-08:00",
        "requested_at": "2023-01-31T16:28:00-08:00"
    },
    {
        "project_id": "ec8231b2-6b20-4ad1-9c59-8e183087a742",
        "id":"xxxxxxxxxxxxxxxxxxxx",
        "status": "accepted",
        "user_id" : "xxxxxxxxxx",
        "user": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "friend_id" : "xxxxxxxx",
        "friend": {
            "id": "xxxxxxxxxx",
            "nickname": "xxxxxxxxxx"
        },
        "created_at": "2023-01-31T16:28:00-08:00",
        "updated_at": "2023-01-31T16:28:03-08:00",
        "requested_at": "2023-01-31T16:28:00-08:00"
    }
]
              JavaScript
              AttributeTypeDescription
              project_idStringプロジェクト ID
              idString固有 ID
              statusString状態
              user_idStringID
              friend_idString友達 ID
              userObjectマイ情報
              friendObject友達情報
              created_atString作成日
              updated_atStringアップデート日
              requested_atStringリクエスト日

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容

              一括友達登録

              多数の友達リストを一括で保存できます。

              Request

              • Method : GET
              • URI : https://dashboard-api.ncloudchat.naverncp.com/v1/api/v1/api/friendship/bulk
              POST
url : https://dashboard-api.ncloudchat.naverncp.com/v1/api/v1/api/friendship/bulk
Header 'x-api-key: 86dcgffae0xxxxxxxxxxxxxx'
Header : 'x-project-id: ec8231b2-6b20-4ad1-xxxx-xxxxxxxxx'
              JavaScript
              HeaderTypeRequiredDescription
              X-API-KEYStringOGamePotで発行する認証キー
              X-PROJECT-IDStringOダッシュボードプロジェクト ID
              AttributeTypeRequiredDescription
              bodyStringOユーザー ID
              curl -X 'POST' \
  'http://localhost:4000/v1/api/friendship/bulk' \
  -H 'accept: application/json' \
  -H 'x-project-id: 339c2b1c-d35b-47f2-828d-5f02a130146a' \
  -H 'x-api-key: f0b1dfa4014035825cb3f55f88114a2516be89317eec7c37' \
  -H 'Content-Type: application/json' \
  -d '[
  {
    "userId": "osoriz",
    "friendId": "aginamoo"
  },
 {
    "userId": "osoriz",
    "friendId": "cat"
  },
 {
    "userId": "osoriz",
    "friendId": "peer"
  }
]'
              Plain text

              Response

              成功

              [
     {
    "userId": "osoriz",
    "friendId": "aginamoo"
  },
 {
    "userId": "osoriz",
    "friendId": "cat"
  },
 {
    "userId": "osoriz",
    "friendId": "peer"
  }
]
              JavaScript
              AttributeTypeDescription
              userIdStringID
              friendIdString友達 ID

              失敗

              {
    "status": -1,
    "message": "エラーメッセージ"
}
              JavaScript
              AttributeTypeDescription
              codeInt結果値(1: 成功、失敗時は Error codeを参照)
              errorStringエラー内容
              この記事は役に立ちましたか?
              Change password!
              Changing your password will log you out immediately. Use the new password to log back in.
              Change profile
              Success!
              First name must have atleast 2 characters. Numbers and special characters are not allowed.
              Last name must have atleast 1 characters. Numbers and special characters are not allowed.
              Enter a valid email
              Enter a valid password
              Your profile has been successfully updated.
              Logout