You need to enable JavaScript to run this app.
导航
实时音视频
  • 文档首页
    • /实时音视频/即时通讯 IM/服务端 API 参考/服务端 OpenAPI/会话相关/会话查询/查询用户拥有会话 GetUserConversations
查询用户拥有会话 GetUserConversations
最近更新时间：2024.04.01 14:10:02首次发布时间：2023.04.24 11:11:46
我的收藏

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

使用说明

接口行为

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

调用接口

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

注意事项

QPS 不得超过 100。

请求说明

  • 请求方式：POST
  • 请求地址：https://rtc.volcengineapi.com?Action=GetUserConversations&Version=2020-12-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是GetUserConversations接口名称。当前 API 的名称为 GetUserConversations。
VersionString是2020-12-01接口版本。当前 API 的版本为 2020-12-01。

Body

参数类型是否必选示例值描述
AppIdInteger是000000应用的唯一标志
ParticipantUserIdLong是10001查询用户 UserId

DataType

Integer

否

0

数据来源。

  • 0：从缓存中拉取，按会话最近活跃排序。
  • 1：从数据库中拉取，按照创建时间正序排序。
  • 2：拉取用户创建的直播群会话，按照创建时间逆序排序
CursorLong是1查询起始位置
LimitLong是2查询数量。最大值为 20。

SkipMemberCount

Boolean

否

true

是否忽略会话成员数。

  • true：忽略。
  • false：不忽略。
    默认值为 false。
InboxTypeInteger否0信箱，用于逻辑隔离。 默认值为 0。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
ConversationInfosArray of ConversationInfo-会话详细信息
HasMoreBooleantrue是否还有更多的数据
NextCursorLong20下一批数据起始位置

ConversationInfo

参数类型示例值描述
ConversationShortIdLong000001会话 ID
ConversationIdStringConversationId会话Id，字符串类型，含义跟ConversationShortId一样，用来定位唯一的一个会话，历史原因，目前大部分接口都在使用ConversationShortId，但是仍然有比较比较老的接口会使用到ConversationId，如果目前您接入的功能没有使用到ConversationId直接忽略即可
AppIdInteger000000应用的唯一标志
InboxTypeInteger0信箱，用于逻辑隔离
NameStringConversation群名
AvatarUrlStringhttp://xxx.com群头像 url
DescriptionStringYour_Description群描述
OwnerUserIdLong10001群主 UserId
CreatorUserIdLong10001创群人 UserId
NoticeStringYour_Notice群公告

Status

Integer

0

会话状态。

  • 0：正常
  • 1：已解散
ExtJSON Map{"key":"value"}会话的扩展字段。
CreateTimeLong1669714409群聊创建时间戳，单位为秒
ModifyTimeLong1669714409修改时间戳，单位为秒

ConversationType

Integer

1

会话类型。

  • 1：单聊
  • 2：群聊
MemberCountLong2会话成员数
OnlineCountLong2直播群在线人数。
OtherUserIdLong10002单聊会话另一个 UserId

请求示例

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

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

返回示例

{
    "ResponseMetadata": {
	      "RequestId": "Your_RequestId",    
        "Action": "GetUserConversations",
        "Version": "2020-12-01",
        "Service": "rtc",        
        "Region": "cn-north-1"
    },
    "Result": {
        "ConversationInfos": [
            {
                "ConversationShortId": 000001,
                "ConversationId":"ConversationId",
                "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,
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。