You need to enable JavaScript to run this app.
导航

查询用户拥有会话 GetUserConversations

最近更新时间2023.11.22 10:54:17

首次发布时间2023.04.24 11:11:46

你可以使用此接口查询某个成员拥有的会话。

接口行为

你可以调用GetUserConversations接口,指定你所属的AppId、用户 ID、查询起始位置和查询数量来查询用户拥有的会话。

调用接口

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

接口限制

QPS 不得超过 100。

请求方式

使用 POST 方式发起请求。

请求参数

Query

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

Body

参数名类型必填示例值描述
AppIdInt000000应用的唯一标志
ParticipantUserIdInt10001查询用户 UserId
CursorInt1查询起始位置
LimitInt2查询数量。最大值为 20
DataTypeInt0数据来源。
  • 0:从缓存中拉取,按会话最近活跃排序。
  • 1:从数据库中拉取,按照创建时间正序排序。
  • 2:拉取用户创建的直播群会话,按照创建时间逆序排序
SkipMemberCountBooltrue是否忽略会话成员数。
  • true:忽略。
  • false:不忽略。
  • 默认值为 false
InboxTypeInt0信箱,用于逻辑隔离。 默认值为 0

请求示例代码

Query

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

Body

{
    "AppId":000000,
    "ParticipantUserId":10001,
    "DataType":0,
    "Cursor":0,
    "Limit":20,
    "SkipMemberCount":true,
    "InboxType":0
}

返回调用结果

返回参数说明

返回结果参看 BaseResponse

其中 Result 的结构如下:

参数名类型描述
ConversationInfosArray of ConversationInfo会话详细信息
HasMoreBool是否还有更多的数据
NextCursorInt下一批数据起始位置

正常返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "GetUserConversations",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "ConversationInfos": [
            {
                "ConversationShortId": 000001,
                "AppId": 000000,
                "InboxType": 0,
                "Name": "Conversation",
                "AvatarUrl: "http://xxx.com",
                "Description": "Your_Description",
                "OwnerUserId": 10001,
                "CreatorUid": 10001,
                "Notice": "Your_Notice",
                "Status": 0,
                "Ext": {
                    "key":"value"
                },
                "CreateTime": 1669714409,
                "ModifyTime": 1669714409,
                "ConversationType": 2,
                "MemberCount": 2,
                "OnlineCount": 0,
                "OtherUserId": 10002
            },
            {
                "ConversationShortId": 000002,
                "AppId": 000000,
                "InboxType": 0,
                "Name": "",
                "AvatarUrl": "",
                "Description": "",
                "OwnerUid": 10001,
                "CreatorUid": 10001,
                "Notice": "",
                "Status": 0,
                "Ext": {
                    "s:imcloud_data_sync_src": "db",
                    "s:s_aid": "666666"
                },
                "CreateTime": 1667976874,
                "ModifyTime": 1667976874,
                "ConversationType": 1,
                "MemberCount": 2,
                "OnlineCount": 0,
                "OtherUserId": 10002
            },
        ],
        "HasMore": true,
        "NextCursor": 20,
    }
}