文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.im.msg.load (加载消息列表)

分页加载消息列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
count Number 必须 10 条数
receiver_id Number 可选 123321
  • 默认值:0
  • 接收者id
    session_code String 必须 123 sessionCode
    session_id Number 可选 123
  • 默认值:0
  • 会话id
    start_index Number 可选 12332131
  • 默认值:0
  • 开始索引
    user_id Number 必须 123321 用户id

    响应参数

    名称 类型 示例值 描述
    data MsgLoadResponse response data
    • └ end
    • Boolean
    • true
    • end
    • message_list
    • MessageModel []
    • messageList
    • messageList
    • └ cancel
    • Boolean
    • false
    • cancel
    • └ deleted
    • Boolean
    • true
    • deleted
    • └ gmt_create
    • Date
    • 21321321
    • gmtCreate
    • └ msg_content
    • String
    • content
    • msgContent
    • └ msg_ext_content
    • String
    • msgExtContent
    • msgExtContent
    • └ msg_id
    • Number
    • 123321
    • msgId
    • └ msg_sender
    • Boolean
    • 123312
    • msgSender
    • └ msg_status
    • Number
    • 1
    • msgStatus
    • └ msg_type
    • String
    • text
    • msgType
    • └ msg_unique_key
    • String
    • 123123321
    • msgUniqueKey
    • └ read
    • Boolean
    • false
    • read
    • └ send_strategy
    • Number
    • 2
    • sendStrategy
    • └ sender_id
    • Number
    • 123321
    • senderId
    • └ sender_nick
    • String
    • aaaa
    • senderNick
    • └ session_id
    • Number
    • 321321
    • sessionId
    • └ user_id
    • Number
    • 123321
    • userId
    • └ uuid
    • String
    • 123213
    • uuid
    • └ create_time
    • Number
    • 123321
    • createTime
    • └ next_index
    • Number
    • 123321321
    • nextIndex
    status_code String INVALID_PARAM statusCode
    status_message String 无效参数 statusMessage
    is_success Boolean false success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoImMsgLoadRequest req = new CainiaoGuoguoImMsgLoadRequest();
    req.setCount(10L);
    req.setReceiverId(123321L);
    req.setSessionCode("123");
    req.setSessionId(123L);
    req.setStartIndex(12332131L);
    req.setUserId(123321L);
    CainiaoGuoguoImMsgLoadResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_guoguo_im_msg_load_response>
        <data>
            <end>true</end>
            <message_list>
                <message_model>
                    <cancel>false</cancel>
                    <deleted>true</deleted>
                    <gmt_create>21321321</gmt_create>
                    <msg_content>content</msg_content>
                    <msg_ext_content>msgExtContent</msg_ext_content>
                    <msg_id>123321</msg_id>
                    <msg_sender>123312</msg_sender>
                    <msg_status>1</msg_status>
                    <msg_type>text</msg_type>
                    <msg_unique_key>123123321</msg_unique_key>
                    <read>false</read>
                    <send_strategy>2</send_strategy>
                    <sender_id>123321</sender_id>
                    <sender_nick>aaaa</sender_nick>
                    <session_id>321321</session_id>
                    <user_id>123321</user_id>
                    <uuid>123213</uuid>
                    <create_time>123321</create_time>
                </message_model>
            </message_list>
            <next_index>123321321</next_index>
        </data>
        <status_code>INVALID_PARAM</status_code>
        <status_message>无效参数</status_message>
        <is_success>false</is_success>
    </cainiao_guoguo_im_msg_load_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

    返回
    顶部