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 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
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
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 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
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
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 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
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
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 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
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
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"} 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
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
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 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
Response Success
Attribute Type Description userId String ID friendId String Friend ID
Failure
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?
Yes No
Thank you for your feedback! Our team will get back to you