taobao.openim.chatlogs.get (openim聊天记录查询接口)

查询openim账号聊天记录

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user1 OpenImUser 必须 用户1信息
  • └ uid
  • String
  • 必须
  • abc
  • 用户id
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 默认值:false
  • 是否为淘宝账号
  • └ app_key
  • String
  • 可选
  • 4712
  • 账户appkey
user2 OpenImUser 必须 用户2信息
  • └ uid
  • String
  • 必须
  • abc
  • 用户id
  • └ taobao_account
  • Boolean
  • 可选
  • false
  • 默认值:false
  • 是否为淘宝账号
  • └ app_key
  • String
  • 可选
  • 4712
  • 账户appkey
begin Number 必须 1433950194 查询开始时间(UTC时间)
end Number 必须 1433950294 查询结束时间(UTC时间)
count Number 必须 100 查询条数
next_key String 可选 sdjfshkhdj== 迭代key

响应参数

名称 类型 示例值 描述
result RoamingMessageResult 聊天记录查询结果
  • └ next_key
  • String
  • sdhfhkhjkhskhfhk==
  • 下次迭代key
  • messages
  • RoamingMessage []
  • 消息列表
  • content_list
  • RoamingMessageItem []
  • 消息内容
  • └ type
  • String
  • T
  • 节点类型
  • └ value
  • String
  • hello
  • └ time
  • Number
  • 1433950294
  • 消息时间(UTC时间)
  • └ direction
  • Number
  • 1
  • 消息方向。user1 -> user2 = 0 , user2->user1 = 1
  • └ uuid
  • Number
  • 65500303031131
  • 消息唯一ID
  • └ type
  • Number
  • 10
  • 消息类型

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpenimChatlogsGetRequest req = new OpenimChatlogsGetRequest();
OpenImUser obj1 = new OpenImUser();
obj1.setUid("abc");
obj1.setTaobaoAccount(false);
obj1.setAppKey("demo");
req.setUser1(obj1);
OpenImUser obj2 = new OpenImUser();
obj2.setUid("abc");
obj2.setTaobaoAccount(false);
obj2.setAppKey("demo");
req.setUser2(obj2);
req.setBegin(1433950194L);
req.setEnd(1433950294L);
req.setCount(100L);
req.setNextKey("sdjfshkhdj==");
OpenimChatlogsGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<openim_chatlogs_get_response>
    <result>
        <next_key>sdhfhkhjkhskhfhk==</next_key>
        <messages>
            <roaming_message>
                <content_list>
                    <roaming_message_item>
                        <type>T</type>
                        <value>hello</value>
                    </roaming_message_item>
                </content_list>
                <time>1433950294</time>
                <direction>1</direction>
                <uuid>65500303031131</uuid>
                <type>10</type>
            </roaming_message>
        </messages>
    </result>
</openim_chatlogs_get_response>

异常示例

  • XML示例
  • JSON示例
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案

API工具

如何获得此API

FAQ

返回
顶部