Friends

Article summary

Did you find this summary helpful?

Thank you for your feedback

Manage friends

Send friend request

Send a friend request to another user. The recipient receives a notification of the request.

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": "Let's be friends!!"
}

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	Friend ID
message	String	X	Message

Response

Success

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

Failure

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

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

Accept friend request

Accept another user's friend request. Upon acceptance, the users are connected as friends.

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

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	Friend ID

Response

Success

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

Failure

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

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

Reject friend request

Reject another user's friend request.

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

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	Friend ID

Response

Success

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

Failure

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

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

Unfriend

This feature allows you to unfriend other users. Unfriending removes the user from your friend list. If you wish to become friends with the user again, you must send a new friend request.

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

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	Friend ID

Response

Success

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

Failure

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

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

Friend list

Displays the current friends list.

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'

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

Filters can be used in a variety of ways depending on the code.
You can search for friends by status code.

"accepted": a list of friends who have accepted to be your friend
"rejected": a list of friends who have rejected your friend request
"requested": a list of friends you have sent a friend request to
"pending": a list of friends you have received a friend request from

Response

Success

[
    {
        "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	Date created
updated_at	String	Date updated
requested_at	String	Request date

Failure

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

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

Add friends in bulk

You can save a list of multiple friends in bulk.

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'

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
body	String	O	User 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"
  }
]'

Response

Success

[
     {
    "userId": "osoriz",
    "friendId": "aginamoo"
  },
 {
    "userId": "osoriz",
    "friendId": "cat"
  },
 {
    "userId": "osoriz",
    "friendId": "peer"
  }
]

Attribute	Type	Description
userId	String	ID
friendId	String	Friend ID

Failure

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

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

Was this article helpful?

What's Next

Issue token

Table of contents

Manage friends