获取站内信消息

最近更新时间:2021-07-16 10:29:11

查看PDF

本文档描述如何获取用户站内信消息。

调用方式

1.服务地址

访问控制的服务接入地址为:contact.api.ksyun.com
默认region:cn-beijing-6

2.通信协议

支持通过 HTTP 或 HTTPS 两种方式进行请求通信,推荐使用安全性更高的 HTTPS方式发送请求。

3.请求方法

openAPI支持GET请求。

4.请求参数

金山云openAPI请求包含两类参数:公共参数和接口请求参数。其中,公共请求参数是每个接口都要用到的请求参数,具体可参见公共参数小节;接口请求参数是各个接口所特有的,具体见各个接口的“请求参数”描述。

5.签名机制
详见签名机制

请求参数

名称 必须 类型 示例值 描述
Action String queryInMailList 操作接口名称,系统规定参数,取值:queryInMailList
Version String 2021-07-08 API版本,固定为2021-07-08
StartTime String 2017-02-28 17:00:00 查询的开始时间,格式:YYYY-MM-DD HH:MM:SS
EndTime String 2017-02-28 18:00:00 查询的开始时间,格式:YYYY-MM-DD HH:MM:SS
PageNumber Integer 1 分页查询页码参数
PageSize Integer 10 分页查询条数参数 最大支持每页100条
CategoryId String 6,7 查询的消息分类。多个用逗号,分隔,参考值如下:
不传就是默认全部

- 5 :财务消息
- 6 :产品消息
- 7 :运维消息
- 9: 安全消息
- 10:活动消息
- 11:金山云动态
TypeId String 64,30,56 查询的消息类型。多个用逗号,分隔,参考值如下:
不传就是默认全部

财务消息(CategoryId=5)
- 19:账户预警通知
- 61:账户资产变动通知
- 69:账户提现相关提醒和通知
- 66:账户发票相关提醒和通知
- 80:账户逾期相关提醒和通知
- 32:产品自动续费相关提醒和通知
- 51:产品欠费相关提醒和通知
- 82:企业财务管理相关提醒和通知

产品消息(CategoryId=6)
- 64:产品服务升级
- 30:网络相关资源创建成功通知
- 55:新产品上线
- 15:产品到期、关停相关信息通知
- 77:产品开通通知
- 78:语音消息服务
- 76:KES集群释放验证码通知
- 50:云主机消息通知
- 72:云游戏消息通知
- 71:短信服务
- 33:高防IP产品通知
- 48:服务器安全产品信息
- 49:证书产品信息
- 70:告警消息
- 57:平台消息

运维消息(CategoryId=7)
- 17:金山云IDC巡检报障消息
- 56:运营商割接

安全消息(CategoryId=9)
- 62:DDoS攻击告警
- 54:安全预警
- 63:违规通知
- 75:AccessKey定期更新通知(6个月)

活动消息(CategoryId=10)
- 79:营销消息

金山云动态(CategoryId=11)
- 53:营销消息
- 58:政策消息
- 59:客户关怀

返回数据(调用成功)

名称 类型 描述
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"
}

文档内容是否对您有帮助?

根本没帮助
文档较差
文档一般
文档不错
文档很好

在文档使用中是否遇到以下问题

内容不全,不深入
内容更新不及时
描述不清晰,比较混乱
系统或功能太复杂,缺乏足够的引导
内容冗长

更多建议

0/200

评价建议不能为空

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

问题反馈