淘宝开放平台

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

菜鸟无线API

cainiao.guoguo.im.msg.read (设置消息已读)

设置消息已读

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
msg_ids Number [] 必须 111,222
  • 最大列表长度：20
    		•  消息列表
    session_code String 必须 avdffsd sessionCode
    session_id Number 必须 123213 会话id
    user_id Number 必须 1232132 用户id

    响应参数

    名称 类型 示例值 描述
    data MsgReadListResponse response data
    • msg_read_list
    • MsgReadResponse []
    • list
    • msgReadList
    • └ msg_id
    • Number
    • 123213
    • msgId
    • └ read_result
    • Boolean
    • true
    • readResult
    status_code String statusCode statusCode
    status_message String statusMessage statusMessage
    is_success Boolean false success

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    1
    2
    3
    4
    5
    6
    7
    8
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoImMsgReadRequest req = new CainiaoGuoguoImMsgReadRequest();
    req.setMsgIds("111,222");
    req.setSessionCode("avdffsd");
    req.setSessionId(123213L);
    req.setUserId(1232132L);
    CainiaoGuoguoImMsgReadResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    <cainiao_guoguo_im_msg_read_response>
        <data>
            <msg_read_list>
                <msg_read_response>
                    <msg_id>123213</msg_id>
                    <read_result>true</read_result>
                </msg_read_response>
            </msg_read_list>
        </data>
        <status_code>statusCode</status_code>
        <status_message>statusMessage</status_message>
        <is_success>false</is_success>
    </cainiao_guoguo_im_msg_read_response>

    异常示例

    • XML示例
    • JSON示例
    1
    2
    3
    4
    5
    6
    <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测试工具 错误码查询工具 SDK下载

    如何获得此API

    FAQ

    我要提问
    返回
    顶部