alibaba.interaction.im.message.list.query (阿里巴巴IM历史聊天消息查询)

阿里巴巴IM历史聊天消息查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
params ListMessagesParamsDTO 必须 列表请求参数
  • └ conversation_id
  • String
  • 必须
  • $2$136935123$
  • 会话ID
  • └ count
  • Number
  • 必须
  • 50
  • 分页数量
  • └ forward
  • Boolean
  • 必须
  • true
  • 消息查询方向,false表示向时间减小的方向查询,true表示时间增大的方向查询
  • └ limit_time_stamp
  • Number
  • 必须
  • 1705542810974
  • 以此时间点向前或向后查询
  • └ self_account_id
  • Number
  • 必须
  • 1
  • 绑定店铺ID

响应参数

名称 类型 示例值 描述
result ResultDTO 返回结果
  • └ error_code
  • Number
  • 1
  • 错误码
  • └ error_msg
  • String
  • system error
  • 错误信息
  • data
  • ListMessagesResultDTO
  • 返回模型
  • └ has_more
  • Boolean
  • true
  • 是否还有更多数据
  • └ next_time_stamp
  • Number
  • 1705542810974
  • 下次拉取时间戳
  • list
  • MessageDTO []
  • 结果列表
  • └ message_type
  • Number
  • 50
  • 消息类型
  • └ message_id
  • String
  • 2130285029059.PNM
  • 消息ID
  • └ conversation_id
  • String
  • $2$13693512348$PNM
  • 会话ID
  • └ send_time
  • Number
  • 1705477256009
  • 发送时间
  • └ sender_account_id
  • Number
  • 111
  • 消息发送人账号ID
  • └ receiver_account_id
  • Number
  • 222
  • 消息接收人账号ID
  • └ content
  • String
  • {\"params\":\"cardType\":12}
  • 消息内容
  • └ success
  • Boolean
  • true
  • 接口执行是否成功

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaInteractionImMessageListQueryRequest req = new AlibabaInteractionImMessageListQueryRequest();
AlibabaInteractionImMessageListQueryRequest.ListMessagesParamsDTO obj1 = new AlibabaInteractionImMessageListQueryRequest.ListMessagesParamsDTO();
obj1.setConversationId("$2$136935123$");
obj1.setCount(50L);
obj1.setForward(true);
obj1.setLimitTimeStamp(1705542810974L);
obj1.setSelfAccountId(1L);
req.setParams(obj1);
AlibabaInteractionImMessageListQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<alibaba_interaction_im_message_list_query_response>
    <result>
        <error_code>1</error_code>
        <error_msg>system error</error_msg>
        <data>
            <has_more>true</has_more>
            <next_time_stamp>1705542810974</next_time_stamp>
            <list>
                <message_d_t_o>
                    <message_type>50</message_type>
                    <message_id>2130285029059.PNM</message_id>
                    <conversation_id>$2$13693512348$PNM</conversation_id>
                    <send_time>1705477256009</send_time>
                    <sender_account_id>111</sender_account_id>
                    <receiver_account_id>222</receiver_account_id>
                    <content>{\&quot;params\&quot;:\&quot;cardType\&quot;:12}</content>
                </message_d_t_o>
            </list>
        </data>
        <success>true</success>
    </result>
</alibaba_interaction_im_message_list_query_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

返回
顶部