API Overview
Message Callbacks
Status Codes
Overview
Adds friends for a user.
Request
Authentication: Add authentication headers to the request. See Authentication.
Method:
POST
Rate limit:
100 requests/second
Endpoint: https://API domain/apigateway/friends/add
Content-Type:
application/json
Request Parameters
| Parameter | Data Type | Required | Description | |
|---|---|---|---|---|
| user_id | string | Yes | User ID. Maximum length: 32 characters. | |
| friends | array | Yes | Friends to add. | |
| friends[].friend_id | string | Yes | Friend's user ID. Maximum length: 32 characters. | |
| friends[].display_name | string | No | Display name assigned to the friend. Maximum length: 50 characters. |
Request Example
POST /apigateway/friends/add HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json
{
"user_id":"userid1",
"friends":[
{
"friend_id":"userid2",
"display_name":"u2"
},{
"friend_id":"userid3",
"display_name":"u3"
}
]
}
Response Example
{
"code":0,
"msg":"sucess"
}