Manage friend

Article summary

Did you find this summary helpful?

Thank you for your feedback

Manage friend

Send friend request

You can send a friend request to other users. The recipients will get notified of your request.

Request

Method : POST
URI : https://gamepot.apigw.ntruss.com/gpapps/v2/friendship/request

POST
url : https://gamepot.apigw.ntruss.com/gpapps/v2/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": "Be my friend!"
}

Header	Type	Required	Description
X-API-KEY	String	O	Authentication key issued by GAMEPOT
X-PROJECT-ID	String	O	Dashboard project ID

Attribute	Type	Required	Description
userId	String	O	User ID
friendId	String	O	Add friend ID
message	String	X	Message

Response

Succeeded

{
   "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"
    }
}

Attribute	Type	Description
friendship.project_id	String	Project ID
friendship.id	String	Input ID
friendship.user_id	String	User ID
friendship.status	String	Status
friendship.user_id	String	ID
friendship.user	Object	My Information
friendship.friend_id	String	Friend ID
friendship.friend	Object	Friend information
friendship.requested_at	String	Request date

Failed

{
    "status": -1,
    "message": "Error message"
}

Attribute	Type	Description
code	Int	Result (1: success, refer to the error code in case of failure)
error	String	Error message

Accept friend request

You can accept friend requests from others. You are connected with the counterpart as friends once you accept the request.

Request

Method : POST
URI : https://gamepot.apigw.ntruss.com/gpapps/v2/friendship/accept

POST
url : https://gamepot.apigw.ntruss.com/gpapps/v2/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"
}

Header	Type	Required	Description
X-API-KEY	String	O	Authentication key issued by GAMEPOT
X-PROJECT-ID	String	O	Dashboard project ID

Attribute	Type	Required	Description
userId	String	O	User ID
friendId	String	O	Add friend ID

Response

Succeeded

{
   "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"
    }
}

Attribute	Type	Description
friendship.project_id	String	Project ID
friendship.id	String	Input ID
friendship.user_id	String	User ID
friendship.status	String	Status
friendship.user_id	String	ID
friendship.friend_id	String	Friend ID
friendship.user	Object	My Information
friendship.friend	Object	Friend information
friendship.requested_at	String	Request date

Failed

{
    "status": -1,
    "message": "Error message"
}

Attribute	Type	Description
code	Int	Result (1: success, refer to the error code in case of failure)
error	String	Error message

Reject friend request

You can reject friend requests from others.

Request

Method : POST
URI : https://gamepot.apigw.ntruss.com/gpapps/v2/friendship/reject

POST
url : https://gamepot.apigw.ntruss.com/gpapps/v2/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"
}

Header	Type	Required	Description
X-API-KEY	String	O	Authentication key issued by GAMEPOT
X-PROJECT-ID	String	O	Dashboard project ID

Attribute	Type	Required	Description
userId	String	O	User ID
friendId	String	O	Add friend ID

Response

Succeeded

{
   "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"
    }
}

Attribute	Type	Description
friendship.project_id	String	Project ID
friendship.id	String	Input ID
friendship.user_id	String	ID
friendship.friend_id	String	Friend ID
friendship.status	String	Status
friendship.user	Object	My Information
friendship.friend	Object	Friend information
friendship.requested_at	String	Request date

Failed

{
    "status": -1,
    "message": "Error message"
}

Attribute	Type	Description
code	Int	Result (1: success, refer to the error code in case of failure)
error	String	Error message

End friendship

You can break off friendships with other users. If you end a friendship with a user, the user will be removed from the list of your friends. In the case you wish to restore friendship, you can make a new friendship request to the user.

Request

Method : POST
URI : https://gamepot.apigw.ntruss.com/gpapps/v2/friendship

DELETE
url : https://gamepot.apigw.ntruss.com/gpapps/v2/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",
}

Header	Type	Required	Description
X-API-KEY	String	O	Authentication key issued by GAMEPOT
X-PROJECT-ID	String	O	Dashboard project ID

Attribute	Type	Required	Description
userId	String	O	User ID
friendId	String	O	Add friend ID

Response

Succeeded

{
   "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"
    }
}

Attribute	Type	Description
friendship.project_id	String	Project ID
friendship.id	String	Input ID
friendship.status	String	Status
friendship.user_id	String	ID
friendship.friend_id	String	Friend ID
friendship.user	Object	My Information
friendship.friend	Object	Friend information
friendship.requested_at	String	Request date

Failed

{
    "status": -1,
    "message": "Error message"
}

Attribute	Type	Description
code	Int	Result (1: success, refer to the error code in case of failure)
error	String	Error message

Friend list

You can see the current list of your friends.

Request

Method : GET
URI : https://gamepot.apigw.ntruss.com/gpapps/v2/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'

Header	Type	Required	Description
X-API-KEY	String	O	Authentication key issued by GAMEPOT
X-PROJECT-ID	String	O	Dashboard project ID

Attribute	Type	Required	Description
filter	String	O	Search is available for all fields of a query through filtering.
user_id	String	O	User ID

** Filter can be useful depending on codes.
You can search through the list of friends with status codes.

"accepted": the list of users who accepted my friend request
"rejected": the list of users who rejected my friend request
"requested": the list of users to whom I sent a friend request
"pending": the list of users who received my friend requests

Response

Succeeded

[
    {
        "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"
    }
]

Attribute	Type	Description
project_id	String	Project ID
id	String	Unique ID
status	String	Status
user_id	String	ID
friend_id	String	Friend ID
user	Object	My Information
friend	Object	Friend information
created_at	String	Creation date
updated_at	String	Updated date
requested_at	String	Request date

Failed

{
    "status": -1,
    "message": "Error message"
}

Attribute	Type	Description
code	Int	Result (1: success, refer to the error code in case of failure)
error	String	Error message

Was this article helpful?

What's Next

Advance reservation participation

Table of contents

Manage friend