API概览
更新时间:
复制 MD 格式
API标准及多语言预置SDK
本产品(Notifications/2024-12-25)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。
订阅
|
API |
标题 |
API概述 |
| ReadCategoryGroupList | 获取分类组列表 | 获取分类组列表 |
| ReadMessageLanguage | 获取消息语言 | 获取消息语言。 |
| UpdateMessageLanguage | 更新消息语言 | 更新消息语言 |
站内信
|
API |
标题 |
API概述 |
| ReadAllMessage | 将全部消息置为已读 | 方法描述:分类全部标记为已读,不填则全部标记 |
| ReadMessageNewTotal | 获取未读消息总数 | 方法描述:获取未读消息总数 |
| ReadMessage | 将消息置为已读 | 方法描述:消息标记为已读 |
| ReadMessageList | 获取消息列表 | 方法描述:获取消息列表。 |
| ReadNumGroupByClass | 获取各分类已读消息数 | 方法描述:获取各分类已读消息数 |
| DelMessage | 删除消息 | 方法描述:删除消息。 |
| ReadNumGroupTotal | 获取所有分类下的信息 | 方法描述:获取所有分类下的信息 |
| ReadMessageContent | 获取消息内容 | 方法描述:获取消息正文 |
| ReadClassName | 获取类目名称 | 方法描述:获取各分类已读消息数 |
| DeleteAllMessage | 删除全部消息 | 方法描述:站内信全部删除(逻辑删除)。 |
其他
|
API |
标题 |
API概述 |
| CreateWebhookContact | 创建webhook联系人 | 创建webhook联系人。 |
| DeleteWebhookContact | 删除Webhook联系人 | 删除webhook联系人。 |
| ReadAllCommonContacts | 获取所有通用联系人 | 获取所有账号通用联系人。 |
| ReadAllMarketingPreferences | 获取所有用户营销偏好 | 获取所有营销偏好配置。 |
| ReadAllWebhookContacts | 获取所有webhook联系人 | 获取全量webhook列表 |
| ReadCommonContact | 获取通用联系人 | 获取通用联系人 |
| ReadMarketingPreference | 获取营销偏好设置 | 获取用户营销偏好。 |
| ReadMetaConfig | 获取页面元数据 | 获取元数据服务 |
| ReadRevisionHistoryList | 获取修订记录列表 | 获取修订记录 |
| ReadUserSubscriptionList | 获取用户订阅列表 | 获取用户订阅列表 |
| ReadWebhookContact | 获取webhook联系人 | 获取webhook联系人 |
| ReadWebhookContactSendTemplateList | 获取webhook发送模板 | 获取Webhook发送模板列表 |
| ResetUserSubscription | 重置用户订阅 | 重置用户订阅 |
| TestWebhookContact | 测试webhook联系人 | 测试 Webhook |
| UpdateMarketingPreference | 更新营销偏好 | 更新营销偏好 |
| UpdateUserSubscription | 更新用户订阅信息 | 更新用户订阅。 |
| UpdateWebhookContact | 更新webhook联系人 | 修改webhook联系人。 |
该文章对您有帮助吗?