全部文档
当前文档
最近更新时间：2024-01-26 18:39:56
本文档描述如何获取用户站内信消息。
1.服务地址
访问控制的服务接入地址为：contact.api.ksyun.com
默认region：cn-beijing-6
2.通信协议
支持通过 HTTP 或 HTTPS 两种方式进行请求通信，推荐使用安全性更高的 HTTPS方式发送请求。
3.请求方法
openAPI支持GET请求。
4.请求参数
金山云openAPI请求包含两类参数：公共参数和接口请求参数。其中，公共请求参数是每个接口都要用到的请求参数，具体可参见公共参数小节；接口请求参数是各个接口所特有的，具体见各个接口的“请求参数”描述。
5.签名机制
详见签名机制。
名称 | 必须 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|
Action | 是 | String | queryInMailList | 操作接口名称，系统规定参数，取值： |
Version | 是 | String | 2021-07-08 | API版本，固定为 |
StartTime | 是 | String | 2017-02-28 17:00:00 | 查询的开始时间，格式： |
EndTime | 是 | String | 2017-02-28 18:00:00 | 查询的开始时间，格式： |
PageNumber | 是 | Integer | 1 | 分页查询页码参数 |
PageSize | 是 | Integer | 10 | 分页查询条数参数 最大支持每页100条 |
CategoryId | 否 | String | 6,7 | 查询的消息分类。多个用逗号,分隔，参考值如下： |
TypeId | 否 | String | 64,30,56 | 查询的消息类型。多个用逗号,分隔，参考值如下： |
名称 | 类型 | 描述 |
|---|---|---|
Data | Array | 返回值为我的站内信消息列表数据 |
List | Array | 数据列表 |
Id | Integer | 站内信消息ID |
CreatedTime | String | 创建时间 |
Title | String | 消息主题 |
Content | String | 消息内容（正文） |
CategoryId | Integer | 消息分类 |
TypeId | Integer | 消息类型 |
TypeName | String | 一级消息类型名称 |
CategoryName | String | 消息分类名称 |
Total | Integer | 总条数 |
RequestId | String | 接口请求的唯一ID, 每次调用RequestID唯一 |
http://contact.api.ksyun.com/?
Action=queryInMailList
&Version=2021-07-08
&StartTime=2017-02-28 17:00:00
&EndTime=2017-02-28 18:00:00
&PageNumber=1
&PageSize=10
&CategoryId=6,9
&TypeId=64,30,62
&公共请求参数{
"Data": {
"List": [
{
"Id": 2008790,
"CreatedTime": "2021-05-21 11:36:40",
"Title": "test 1",
"Content": "<html>111111</html>",
"CategoryId": 6,
"TypeId": 64,
"TypeName": "产品服务升级",
"CategoryName": "产品消息"
},
{
"Id": 2008791,
"CreatedTime": "2021-05-21 11:36:40",
"Title": "test 2",
"Content": "<html>2222</html>",
"CategoryId": 7,
"TypeId": 56,
"TypeName": "运营商割接",
"CategoryName": "运维消息"
}
],
"Total": 30109
},
"RequestId": "ccd202c2-49a6-447f-9fa9-03eb279d9aa4"
}纯净模式