You need to enable JavaScript to run this app.
导航
更新好友 UpdateFriend
最近更新时间:2023.11.27 20:36:34首次发布时间:2023.08.16 19:53:36

你可以使用此接口对好友信息进行更新。

接口行为

你可以调用 UpdateFriend 接口,指定你所属的 AppId、用户 ID 和 好友 ID 更新好友信息。 一次最多支持更新 10 个好友。

调用接口

关于调用接口的服务地址、通信协议、字符编码和签名机制,参看调用 OpenAPI

请求方式

使用 POST 方式发起请求。

请求参数

Query

参数名类型必填示例值描述
ActionStringUpdateFriend接口名称,本接口取值:UpdateFriend
VersionString2020-12-01接口版本,本接口取值:2020-12-01

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
UserIdInt10001用户 UserId
InboxTypeInt0信箱,用做逻辑隔离。默认值为 0
FriendInfosArray of FriendInfo/好友信息

FriendInfo

参数名类型必填示例值描述
FriendUserIdInt000001好友 UserId
ExtMap-key(string)-value(string){"key":"value"}好友扩展字段。ExtAlias 为非必填字段,但是至少需要填一个,否则服务端会报错。
AliasStringYour_Alias好友备注

请求示例代码

Query

https://rtc.volcengineapi.com?Action=UpdateFriend&Version=2020-12-01

Body

{
    "AppId":000000,
    "UserId":10001,
    "FriendInfos":[
        {
            "FriendUserId":10002,
            "Ext":{"test":"test"}
        },
        {
            "FriendUserId":10003,
            "Ext":{"7778":"777"}
        }
    ]
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
FailedInfosArray of FailedInfo更新失败的好友信息

FailedInfo

参数名类型描述
UserIdInt好友 UserId
CodeString错误码
MessageString错误描述

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "Your_RequestId",
        "Action": "UpdateFriend",
        "Version": "2020-12-01",
        "Service": "rtc",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedInfos": []
    }
}