消息盒子.md 4.91 KB

Raw Blame History Permalink



1、获取站内信列表

1、获取站内信列表（method=app.inbox.getlistnew）


公共请求参数


参数名称
参数类型
长度
可否为空
示例
默认值
备注


client_secret
string
50
否
5ac68f20cb18efe154be

进入接口提供的参数加密信息


app_version
float
10
否
1

APP版本


os_version
string
20
否
Android4.4

系统版本+机器型号


client_type
string
20
否
iphone/android/ipad

手机型号（不区分大小写）


screen_size
string
20
否
800x900

（手机尺寸）


请求参数 参数对象 GetListReqBO.java


参数名称
参数类型
长度
可否为空
示例
默认值
备注


uid
int
否
1-11
3566164

用户id


size
int
是
1-11
10

每页查询数量


displayTab
String
是

0

前端展示分类(1:* 1-会员信息,2-我的资产,3-客户服务,4-其他为空时查询全部)


接口说明


接口说明


请求域名
http://api.yoho.cn


接口名
app.inbox.getlistnew


获取用户地址信息


http请求方式
POST/GET


返回错误


错误code
错误提示


500
User ID Is Null.


注意，通用的头部没有列出。 
请求示例

http://192.168.102.205:8080/gateway?method=app.inbox.getlistnew&uid=8040080......


响应

code为200即为成功，否则是失败。 
响应参数，data部分

响应成功JSON格式如下所示(注意BODY部分不同类型消息有不同类型的字段,以下BODY以生日券消息场景为例):

{ "alg" :"SALT_MD5",
    "code" :200,
    "data" :{ 
        "total" :1,
        "page_total" :1,
        "page" :1,
        "list" :[ { 
            "create_time" :1464366488,
            "title" :"您有1张优惠券可领取",
            "body" :{ "collar_time" :"2016.04.21-2016.05.31",
                "use_time" :"2016.05.01-2016.05.31",
                "year" :"2016",
                "inbox_name" :"生日券",
                "name" :"2016年05月生日券",
                "is_over_time" :"Y"，
                "img_url" :"http://img12.static.yhbimg.com/couponImg/2017/01/06/10/02226978cdadc9006c52ac2e9df86bf613.png"},
            "is_read" :"N",
            "uid" :4474410,
            "from" :"有货",
            "id" :152,
            "create_date" :"2016-05-28",
            "type" : "pushCoupon",
            "businessType" :201,
            "pcLink" : "",
            "appLink" : ""} ] 
    },
    "md5" :"2b3702a4ff799aafb6368adc1b115a6a",
    "message" :"inbox list" 
  }


响应失败JSON格式如下所示:


2、获取站内信所有分类信息、最新未读消息预览及未读数量

获取站内信所有分类信息、最新未读消息预览及未读数量（method=app.inbox.getAllInboxCatInfo)


公共请求参数


参数名称
参数类型
长度
可否为空
示例
默认值
备注


client_secret
string
50
否
5ac68f20cb18efe154be

进入接口提供的参数加密信息


app_version
float
10
否
1

APP版本


os_version
string
20
否
Android4.4

系统版本+机器型号


client_type
string
20
否
iphone/android/ipad

手机型号（不区分大小写）


screen_size
string
20
否
800x900

（手机尺寸）


请求参数 参数对象 GetListReqBO.java


参数名称
参数类型
长度
可否为空
示例
默认值
备注


uid
int
否
1-11
5088610

用户id


接口说明


接口说明


请求域名
http://api.yoho.cn


接口名
app.inbox.getAllInboxCatInfo


获取用户地址信息


http请求方式
POST


返回错误


错误code
错误提示


500
User ID Is Null.


注意，通用的头部没有列出。 
请求示例

http://192.168.102.205:8080/gateway?method=app.inbox.getAllInboxCatInfo&uid=5088610


响应

code为200即为成功，否则是失败。 
响应参数，data部分

响应成功JSON格式如下所示（注意BODY部分不同类型消息有不同类型的字段,以下BODY以生日券消息场景为例）: 

{ "code" :"200",
  "message" :"success",
    "data" :
    [{ 
        "createTime" :"",
        "id" :1,
        "businessType" :"",
        "title" :"",
        "body" :{ },
        "inboxCatName" :"会员信息",
        "unReadCount" :0 },
     { 
        "createTime" :"2016-05-28 00:28:08",
        "id" :2,
        "title" : "您有1张优惠券可领取",
        "body" :{ 
            "collar_time" :"2016.04.21-2016.05.31",
            "use_time" :"2016.05.01-2016.05.31",
            "year" :"2016",
            "inbox_name" :"生日券",
            "name" :"2016年05月生日券",
            "is_over_time" :"Y" },
        "businessType" :"",
        "inboxCatName" :"我的资产",
        "unReadCount" :1 },
     { 
        "createTime" :"",
        "id" :3,
        "businessType" :"",
        "title" :"",
        "body" :{ },
        "inboxCatName" :"客户服务",
        "unReadCount" :0 },
     { 
        "createTime" :"",
        "id" :4,
        "businessType" :"",
        "title" :"",
        "body" :{ },
        "inboxCatName" :"其他",
        "unReadCount" :0 
    }] 
}


响应失败JSON格式如下所示:

{"message":"uid is null","code":600001010}