文档中心 > API类目 > 驿马前台api

cainiao.yima.msgcenter.allmessage.pull (拉取所有消息)

消息中心一次拉取接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 11 userId
session_code String 必须 sessionCode sessionCode

响应参数

名称 类型 示例值 描述
data YmAllMessageDto data data
  • message_dto_list
  • YmMessageDto []
  • YmMessageDto
  • messageDTOList
  • └ group_id
  • String
  • groupId
  • groupId
  • └ group_image_url
  • String
  • groupImageURL
  • groupImageURL
  • └ group_title
  • String
  • groupTitle
  • groupTitle
  • sub_message_dto_list
  • YmSubMessageDto []
  • subMessageDTOList
  • subMessageDTOList
  • └ jump_path
  • String
  • jumpPath
  • jumpPath
  • └ message_date
  • Number
  • messageDate
  • messageDate
  • └ message_id
  • String
  • messageId
  • messageId
  • └ message_info
  • String
  • messageInfo
  • messageInfo
  • └ message_show_type
  • Number
  • 1
  • messageShowType
  • └ message_title
  • String
  • messageTitle
  • messageTitle
  • └ need_show_alert
  • Boolean
  • false
  • needShowAlert
  • └ is_read
  • Boolean
  • false
  • read
  • └ unread_message_count
  • Number
  • 10
  • unreadMessageCount
  • └ message_type
  • Number
  • messageType
  • messageType
  • └ unread_all_message_count
  • Number
  • unreadAllMessageCount
  • unreadAllMessageCount
status_code String statusCode statusCode
status_message String statusMessage statusMessage
is_success Boolean false success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaMsgcenterAllmessagePullRequest req = new CainiaoYimaMsgcenterAllmessagePullRequest();
req.setUserId(11L);
req.setSessionCode("sessionCode");
CainiaoYimaMsgcenterAllmessagePullResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_yima_msgcenter_allmessage_pull_response>
    <data>
        <message_dto_list>
            <ym_message_dto>
                <group_id>groupId</group_id>
                <group_image_url>groupImageURL</group_image_url>
                <group_title>groupTitle</group_title>
                <sub_message_dto_list>
                    <ym_sub_message_dto>
                        <jump_path>jumpPath</jump_path>
                        <message_date>messageDate</message_date>
                        <message_id>messageId</message_id>
                        <message_info>messageInfo</message_info>
                        <message_show_type>1</message_show_type>
                        <message_title>messageTitle</message_title>
                        <need_show_alert>false</need_show_alert>
                        <is_read>false</is_read>
                    </ym_sub_message_dto>
                </sub_message_dto_list>
                <unread_message_count>10</unread_message_count>
            </ym_message_dto>
        </message_dto_list>
        <message_type>messageType</message_type>
        <unread_all_message_count>unreadAllMessageCount</unread_all_message_count>
    </data>
    <status_code>statusCode</status_code>
    <status_message>statusMessage</status_message>
    <is_success>false</is_success>
</cainiao_yima_msgcenter_allmessage_pull_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

返回
顶部