聊天记录高级查询

obj1 不能是群组。
obj1空，obj2空，查询所有消息。
obj1非空，obj2空，查询所有obj1发出的消息。
obj1空，obj2非空，查询所有obj2收到的消息。obj2可以是群组。
obj1非空，obj2非空，obj1==obj2，查询所有obj1发出~~~~和收到的消息。
obj1非空，obj2非空，obj2不是群组：查询obj1和obj2的交互聊天记录。
obj1非空，obj2非空，obj2是群组：查询obj1发送给obj2的消息。

消息内容格式：
text,custom: {textMsg:"xxxx"}
file,picture,audio,video,confaudio: {fileID:"xxx",fileSize:"121212",fileName:"xxx.jpg",duration:10000}；duration表示音视频文件时长，单位毫秒
gps: 同查询GPS数据接口中gps对象{lat:31.54512,lng:117.54545,height:6521,angle:2154,speed:212,startCount:3}；单位分别为：度，度，厘米，1/1000度，米/小时，个。

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Authorization

string

必需

login成功返回的token

Body 参数application/json

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

filter

object

过滤条件

可选

minid

number

可选

消息ID范围[min,max]，0不过滤。

maxid

number

可选

消息ID范围[min,max]，0不过滤。

beginTime

number

必需

消息时间范围[begin,end]

endTime

number

必需

消息时间范围[begin,end]

msgType

string

消息类型

可选

match

string

模糊匹配消息内容

可选

beenRead

enum<number>

可选

消息是否已读，已读未读只有在指定具体对象的情况下才有效

枚举值:

012

obj1ID

string

对象1ID

可选

obj1Type

enum<string>

对象1类型

可选

枚举值:

UserPU

obj2ID

string

对象2ID

可选

obj2Type

enum<string>

对象2类型

可选

枚举值:

UserPUIMGroupPUGroupUserGroup

示例

{
    "page": 0,
    "pageSize": 0,
    "filter": {
        "minid": 0,
        "maxid": 0,
        "beginTime": 0,
        "endTime": 0,
        "msgType": "string",
        "match": "string",
        "beenRead": 0,
        "obj1ID": "string",
        "obj1Type": "User",
        "obj2ID": "string",
        "obj2Type": "User"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

enum<integer>

错误码

必需

枚举值:

012357468916101112131415171819

msg

string

结果描述

必需

pageInfo

object (pageInfo)

分页结果信息

可选

page

number

分页,从零开始

必需

pageSize

number

分页大小

必需

totalCount

number

条目总数

必需

data

array[object (im_message) {10}]

成员列表

可选

number

消息ID

必需

speaker

string

发送者ID

必需

speakerType

enum<string>

发送者类型

必需

枚举值:

UserPU

speakerName

string

发送者名称

可选

audience

string

接收者ID

必需

audienceType

enum<string>

接收者类型

必需

枚举值:

UserPUIMGroupPUGroupUserGroup

audienceName

string

接收者名称

可选

time

number

发送时间

必需

msgType

enum<string>

消息类型

必需

枚举值:

textgpsfilepictureaudiovideoconfaudionotifycontrolcustomsystem

msgContent

string

必需

消息内容: json

示例

{
    "code": 0,
    "msg": "string",
    "pageInfo": {
        "page": 0,
        "pageSize": 0,
        "totalCount": 0
    },
    "data": [
        {
            "id": 0,
            "speaker": "string",
            "speakerType": "User",
            "speakerName": "string",
            "audience": "string",
            "audienceType": "User",
            "audienceName": "string",
            "time": 0,
            "msgType": "text",
            "msgContent": "string"
        }
    ]
}