最近更新时间：2023.11.27 20:36:34
首次发布时间：2023.08.16 19:53:36
你可以使用此接口添加好友。
你可以调用 AddFriend 接口，指定你所属的 AppId、用户 ID 和 好友 ID 双向添加好友。 一次最多支持添加 10 个好友。
关于调用接口的服务地址、通信协议、字符编码和签名机制，参看调用 OpenAPI。
QPS 不得超过 50。
使用 POST 方式发起请求。
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | AddFriend | 接口名称，本接口取值：AddFriend |
| Version | String | 是 | 2020-12-01 | 接口版本，本接口取值：2020-12-01 |
| 参数名 | 类型 | 必填 | 示例值 | 描述 |
|---|---|---|---|---|
| AppId | Int | 是 | 000000 | 应用的唯一标志 |
| UserId | Int | 是 | 10001 | 用户 UserId |
| InboxType | Int | 否 | 0 | 信箱，用做逻辑隔离。默认值为 0 |
| FriendUserIds | Array of Int | 是 | [10002，10003] | 好友 UserId，一次最多添加 10 个好友 |
| Ext | Map-key(string)-value(string) | 否 | {"key":"value"} | 好友扩展字段 |
https://rtc.volcengineapi.com?Action=AddFriend&Version=2020-12-01
{ "AppId":000000, "UserId":10001, "InboxType":0, "FriendUserIds":[10002，10003], "Ext":{ "key":"value" } }
返回结果参看 BaseResponse。
其中 Result 的结构如下：
| 参数名 | 类型 | 描述 |
|---|---|---|
| FailedInfos | Array of FailedInfo | 添加失败的好友信息 |
FailedInfo
| 参数名 | 类型 | 描述 |
|---|---|---|
| UserId | Int | 好友 UserId |
| Code | String | 错误码 |
| Message | String | 错误描述 |
{ "ResponseMetadata": { "RequestId": "Your_RequestId", "Action": "AddFriend", "Version": "2020-12-01", "Service": "rtc", "Region": "cn-north-1" }, "Result": { "FailedInfos": [] } }