API标准及多语言预置SDK
本产品（cams/2020-06-06）的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。
在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
自定义签名场景
若您的业务场景有特殊需求，需通过自签名方式对接 API，建议优先咨询我们的技术支持团队（服务钉钉群：147535001692），获取专业指导以确保高效接入。
账号与安全准备
阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露，所有相关资源都将面临未经授权访问的风险。为确保安全，建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey，同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下，才使用阿里云账号。
IM 群组管理
|
API |
标题 |
API概述 |
| AddChatGroup | 创建IM群 | 创建IM群。 |
| AddChatGroupInviteLink | 添加IM群邀请链接 | 添加IM群邀请链接。 |
| DeleteChatGroupInviteLink | 删除IM群邀请链接 | 删除IM群邀请链接。 |
| DeleteChatGroupParticipants | 删除IM群成员 | 删除进入IM群的成员。 |
| ListChatGroupParticipants | IM群成员列表 | 获取IM群成员列表。 |
| ListChatGroup | IM群列表 | 获取IM群列表。 |
| UpdateChatGroup | 修改IM群信息 | 修改IM群信息。 |
| DeleteChatGroup | 删除IM群 | 删除已创建成功的IM群。 |
Messenger营销消息
|
API |
标题 |
API概述 |
| SyncMessengerSubscriptionToken | 同步自定义受众Token | 查询Messenger订阅token。 |
| SyncMessageCampaign | 同步预算信息 | 同步查询预算。 |
| ListMessengerSubscriptionToken | 查询自定义受众、订阅token列表 | 查询自定义受众、订阅token列表。 |
| ListMessageCampaign | 查询预算列表 | 查询预算列表。 |
| ListCustomAudience | 自定义受众查询 | 自定义受众列表查询。 |
| GetMessageCampaignInsights | 获取营销活动预算的成效分析数据 | 查询预算指标。 |
| DeleteMessageCampaign | 删除messenger消息营销活动预算 | 删除发送Messenger消息创建的营销活动预算。 |
| CreateMessageCampaign | 创建预算 | 创建预算。 |
| CreateCustomAudience | 创建自定义受众 | 创建自定义受众。 |
| AddCustomAudienceUser | 增加自定义受众 | 增加自定义受众。 |
实例/Space管理
|
API |
标题 |
API概述 |
| ListInstance | 查询实例列表 | 查询实例列表。 |
| QueryInstance | 查询实例 | 查询实例。 |
流程编辑器
|
API |
标题 |
API概述 |
| TriggerChatFlow | 触发已上线的流程版本 | 触发已上线且触发器类型为手动的流程版本。 |
Whatsapp Flow
|
API |
标题 |
API概述 |
| CreateFlow | 创建Flow | 创建Flow。 |
| ListFlow | 查询Flow列表 | 查询Flow列表。 |
| GetFlow | 获取Flow详细信息 | 获取Flow详细信息。 |
| SyncFlow | 同步Whatsapp flow | 同步flow |
| ModifyFlow | 修改Flow基础信息 | 修改Flow基础信息。 |
| UpdateFlowJSONAsset | 使用JSON更新Flow内容 | 使用JSON更新Flow内容。 |
| GetFlowJSONAssest | 获取Flow的JSON内容 | 获取Flow的JSON格式的内容。 |
| GetFlowPreviewUrl | 获取Flow预览URL | 获取Flow预览URL。 |
| PublishFlow | 发布Flow | 发布Flow。 |
| DeprecateFlow | 弃用Flow | 弃用Flow。 |
| DeleteFlow | 删除Flow | 删除Flow（只有在DRAFT状态的Flow才允许删除）。 |
嵌入式相关
|
API |
标题 |
API概述 |
| IsvGetAppId | 获取App ID | ISV获取App ID。 |
| ChatappBindWaba | 绑定waba | 北向接口绑定Waba。 |
| GetPermissionByCode | 根据嵌入式得到的Code获取授权权限 | 根据嵌入式得到的Code获取授权权限。 |
| ChatappSyncPhoneNumber | 同步号码信息 | 同步号码信息。 |
| AddChatappPhoneNumber | 增加Whatsapp号码 | 增加号码到Waba中。 |
| GetPhoneNumberVerificationStatus | 查询号码验证状态 | 获取号码验证状态。 |
| GetChatappVerifyCode | 获取号码验证码 | 北向接口获取验证码。 |
| ChatappVerifyAndRegister | 号码校验并注册 | 北向接口校验验证码并注册。 |
| ChatappPhoneNumberRegister | 号码注册 | 北向接口注册号码。 |
| ChatappPhoneNumberDeregister | 取消注册Whatsapp号码 | 从Waba中取消注册号码。 |
| QueryWabaBusinessInfo | 查询waba商业信息 | 获取Waba账号Business平台信息。 |
| UpdatePhoneWebhook | 修改号码回调地址信息 | 修改号码回调地址信息。 |
| UpdateAccountWebhook | 修改账号回调地址信息 | 修改账号回调地址信息。 |
| QueryPhoneBusinessProfile | 查询号码商业信息 | 查询号码商业信息。 |
| ModifyPhoneBusinessProfile | 修改号码商业信息 | 修改号码商业信息。 |
| CreateChatappMigrationInitiate | 创建需要迁移号码 | 新增迁移号码。 |
| GetMigrationVerifyCode | 获取迁移号码的验证码 | 获取迁移号码的验证码。 |
| ChatappMigrationVerified | 迁移号码校验 | 迁移号码校验。 |
| ChatappMigrationRegister | 迁移号码注册 | 迁移号码注册。 |
| GetChatappUploadAuthorization | 获取上传文件的鉴权信息 | 获取上传文件的鉴权信息。 |
| GetCommerceSetting | 获取号码商业设置状态 | 获取号码商业设置状态。 |
| UpdateCommerceSetting | 修改号码商业设置状态 | 修改号码商业设置状态。 |
| SyncBusinessAppHistory | Business App 历史消息同步 | 同步business app历史记录等。 |
号码管理
|
API |
标题 |
API概述 |
| GetWhatsappHealthStatus | 获取Whatsapp消息发送健康状态 | 获取不同类型的节点发送消息的健康状态。 |
| UpdateConversationalAutomation | 修改号码欢迎消息、开场白和命令 | 修改号码欢迎消息、开场白和命令。 |
| GetConversationalAutomation | 获取号码欢迎消息、开场白和命令 | 获取欢迎消息、开场白和命令。 |
| GetPhoneEncryptionPublicKey | 获取号码的加密公钥 | 获取号码的加密公钥。 |
| UpdatePhoneEncryptionPublicKey | 更新号码的加密公钥 | 更新号码的加密公钥。 |
| UpdatePhoneMessageQrdl | 修改消息二维码 | 修改消息二维码。 |
| ListPhoneMessageQrdl | 查询消息二维码列表 | 查询消息二维码列表数据。 |
| DeletePhoneMessageQrdl | 删除消息二维码 | 删除消息二维码。 |
| CreatePhoneMessageQrdl | 创建消息二维码 | 创建消息二维码。 |
| QueryChatappPhoneNumbers | 查询客户下的所有发送号码及号码状态 | 查询客户下的所有发送号码及号码状态。 |
| QueryChatappBindWaba | 查询客户绑定的Waba | 查询客户绑定的WABA。 |
| UpdateWhatsappUserName | 修改Whatsapp 商家号码的User name | 更新Whatsapp user name |
| DeleteWhatsappUserName | 删除Whatsapp商家号码的User name | 删除Whatsapp user name |
| GetWhatsappUserName | 获取Whatspp商家号码的User name | 获取Whatsapp user name |
| GetWhatsappUserNameSuggestions | 获取Whatsapp商家号码建议的User name | 获取Whatsapp建议的user name |
消息发送
|
API |
标题 |
API概述 |
| SendChatappMassMessage | 批量发送ChatApp消息 | 批量发送ChatApp消息。 |
| SendChatappMessage | 发送ChatApp消息 | 发送ChatApp消息。 |
| WhatsappCall | Whatsapp语音电话 | 呼叫、接听、挂断Whatsapp语音电话。WhatsApp 语音通话功能目前处于邀请制阶段，如需使用，请联系客户经理或客服人员申请加白。未经加白直接接入无法正常使用该功能。 |
模板管理
|
API |
标题 |
API概述 |
| CreateChatappTemplate | 创建ChatApp模板 | 创建消息模板，模板审核通过后可以发送消息。 |
| ModifyChatappTemplate | 修改ChatApp模板 | 修改消息模板。只能修改未审核以及审核不通过的模板。 |
| ListChatappTemplate | 查询ChatApp模板列表 | 获取消息模板列表。 |
| GetChatappTemplateDetail | 查询ChatApp模板详情 | 获取ChatApp消息模板的详细信息。 |
| DeleteChatappTemplate | 删除ChatApp模板 | 删除消息模板。 |
| CheckDirectSendMessageSample | WHATSAPP 直发模板校验内容 | WHATSAPP直发模板校验内容。 |
| GetAutoGeneratedTemplate | 获取直发自动创建的模板 | 查询自动生成的模板。 |
| ArchiveChatappTemplate | 归档模板 | 归档Chatapp模板，暂时只有Whatsapp模板支持归档 |
商品目录
|
API |
标题 |
API概述 |
| ListProductCatalog | 商品目录列表 | 查询Meta Business平台的目录列表。 |
| GetWhatsappConnectionCatalog | 获取Waba绑定的目录 | 获取Waba关联的目录。 |
| ListProduct | 商品列表 | 查询目录下的商品列表。 |
统计指标
|
API |
标题 |
API概述 |
| GetChatappPhoneNumberMetric | 查询号码的发送量指标 | 查询WhatsApp类型通道号码的发送量指标。 |
| EnableWhatsappROIMetric | 开启Whatsapp ROI指标统计 | 开启Whatsapp相关指标统计。 |
| GetChatappTemplateMetric | 获取营销类型模板的相关指标 | 获取营销类型模板的相关指标。 |
| RequestWhatsappConversionApi | 请求Whatsapp Conversion api | 请求Whatsapp Conversion api |
其他
|
API |
标题 |
API概述 |
| ListChatappMessage | 查询消息清单 | 查询消息清单。 |
| GetPreValidatePhoneId | 获取预校验号码的ID | 预注册号码获取ID，用来在嵌入式中选择，不用重新获取验证码。 |
| CreateChatFlow | 创建流程 | 创建流程。 |
| CreateChatFlowByImport | 创建并导入流程 | 创建并导入流程。 |
| CreateChatFlowLogSetting | 创建流程日志设置 | 创建流程日志设置。 |
| CreateFlowVersion | 创建流程版本 | 通过复制流程版本创建新的流程版本。 |
| DeleteChatFlow | 删除流程 | 删除流程。 |
| DeleteFlowVersion | 删除流程版本 | 删除流程版本。 |
| FlowBindPhone | 流程绑定号码或商家账号ID | 流程绑定号码或商家账号ID。 |
| FlowRebindPhone | 流程重新绑定号码或商家账号ID | 流程重新绑定号码或商家账号ID。 |
| FlowUnbindPhone | 流程解除绑定号码或商家账号ID | 流程解除绑定号码或商家账号ID。 |
| GetChatFlowTemplate | 查询流程模板详情 | 查询流程模板详情。 |
| ListBindingRelationsForFlowVersion | 查询已绑定的号码或商家账号ID列表 | 根据流程编码查询已绑定的手机号码或商家账号ID列表。 |
| ListChatFlow | 列举流程 | 列举流程。 |
| ListChatFlowTemplate | 列举流程模板 | 列举流程模板。 |
| ListFlowNodePrototypeV2 | 列举流程组件原型 | 列举流程组件原型。 |
| ListFlowVersion | 列举流程版本 | 列举流程版本。 |
| OfflineFlowVersion | 下线流程版本 | 下线的流程版本。 |
| OnlineFlowVersion | 上线流程版本 | 上线流程版本。 |
| ReadChatFlow | 获取流程详情 | 获取流程详情。 |
| ReadChatFlowLogSetting | 查看流程日志设置 | 查看流程日志设置。 |
| ReadFlowVersion | 获取流程版本 | 获取流程版本。 |
| UpdateChatFlow | 更新流程基础信息 | 根据流程编码更新流程基础信息。 |
| UpdateChatFlowLogSetting | 更新流程日志设置 | 更新流程日志设置。 |
| UpdateContactById | 更新联系人信息 | 修改联系人 |
| UpdateFlowVersion | 更新流程版本DSL数据 | 更新流程版本DSL数据，用于画布更新流程版本。 |
| GetChatappPhoneNumberSetting | 获取Chatapp号码配置 | 获取Chatapp号码其它控制 |
| BeeBotAssociate | 机器人联想 | 根据用户请求，联想知识库中的FAQ。 |
| BeeBotChat | 机器人会话 | 根据机器人唯一标识（机器人Id）与其进行会话。 |
| ChatappEmbedSignUp | 嵌入式入口 | 北向接口嵌入式。 请在调用嵌入式SDK时使用v2版本，此接口即可忽略。 |
| SubmitIsvCustomerTerms | 提交Isv客户的协议信息 | 提交Isv客户的协议信息。 |
| AddAddressRecoverSuspend | 变更目的地/恢复/暂停 | 申请：变更目的地/恢复/暂停 |
| AddAuditViberOpen | 注册viber账号，开户 | 注册viber账号，开户。 |
| AddContacts | 新增联系人 | 编辑联系人-新增联系人 |
| AddGroup | 添加群组 | 添加群组 |
| AddMarketingFlow | 新增营销活动流程 | 新增营销活动 |
| BindInstagramPage | 绑定ins的page | 绑定ins的page |
| BindMessengerPage | 绑定Messenger的Page | 绑定选择的pageId |
| CopyTemplate | 复制模板 | 复制模板 |
| CreateWhatsappConversionApi | 根据嵌入式code获取pageId入库 | 根据嵌入式code获取pageId入库 |
| DeleteContactsByIds | 批量删除联系人 | 删除联系人(选择后删除) |
| DeleteGroupById | 删除群组 | 删除群组 |
| DeleteInstagramPage | 删除ins的page | 删除ins的page |
| DeleteMarketingFlow | 删除营销活动 | 删除营销活动 |
| DeleteMessengerPage | 删除messenger的公共主页 | 删除messenger的page |
| GeneratePresignedUrl | 获取临时的URL | 获取临时的URL |
| GetAuditRequestByTypeUnAudit | Viber待审核单 | 通过类型查询出个人待审核的单子 |
| GetChatappOpenStatus | 查询ChatApp开通状态 | 查询ChatApp开通状态 |
| GetCustomerSite | 查询客户来源站点 | 查询客户来源站点 |
| GetDownloadExcelList | 下载excel数据 | 下载excel数据 |
| GetFbInstagramPages | Instagram公共主页列表 | 获取ins的page列表 |
| GetFbMessengerPages | Messenger公共主页列表 | 获取facebook的pageId列表 |
| GetGroupExist | 查询群组是否重名 | 查询群组是否重名 |
| GetPledgeTemplateAddress | 保证函模板下载地址 | 下载保证函模板的地址 |
| GetViberByRequestNo | 查询申请单 | 通过requestNo查询申请单。 |
| GetViberPauseTimes | Viber可申请暂停的次数 | 可以申请暂停的次数 |
| GetWhatsappConversionApi | 获取嵌入式授权 | 获取嵌入式授权page |
| ListAllGroups | 查询群组列表 | 查询群组列表 |
| ListFacebookPosts | facebook帖子列表 | 查询facebook帖子列表 |
| ListFlowNodeGroup | 列举流程组件分组 | 列举流程组件分组 |
| ListInstagramPage | Instagram公共主页列表 | 获取ins的page |
| ListInstagramPosts | Instagram帖子列表 | 查询instagram帖子列表 |
| ListMarketingFlow | 查询营销活动列表 | 查询活动列表 |
| ListViberServiceMessage | Viber服务号信息展示 | 展示viber申请单服务号卡片 |
| MoveContactToGroup | 联系人分组 | 联系人变更群组 |
| OpenChatappService | 开通Chatapp服务 | 开通Chatapp服务 |
| PauseMarketingFLow | 暂停营销活动 | 暂停服务 |
| RemoveContactById | 移除单个联系人 | 当前群组移除单个联系人 |
| UpdateAuditRequest | 修改viber申请单 | 修改viber申请单。 |
| UpdateGroupName | 修改群组名称 | 群组改名 |
| UpdateMarketingFLow | 修改营销活动信息 | 修改营销活动信息 |
| ChangeResourceGroup | 资源转组 | 资源转组。 |
| CreateInstance | 新建实例 | 新建实例。 |
| DeleteContacts | 删除联系人 | 编辑联系人-删除联系人 |
| DeleteInstance | 删除实例 | 删除实例。 |
| ListWhatAppTemplate | 查询whtatapp模板列表 | 模板列表查询。 |
| UpdateInstance | 修改实例 | 修改实例。 |
| SubmitVerifyCodeResult | 提交验证码校验结果 | 提交验证码校验结果。 |
| BindDmAccount | 绑定DM账号 | 绑定DM账号 |
| CreateMessengerPage | 嵌入式授权messenger | 嵌入式授权messenger |
| GetChatFlowMetric | 获取ChatFlow运行数据 | 获取ChatFlow运行数据。 |
| ListBindDmAccount | 查询绑定的邮箱账号 | 查询绑定的dm账号 |
| ListDmAccount | 查询账号下的Dm账号列表 | 查询账号下的Dm账号 |
| ListDmTag | 查询Dm Tag列表 | 查询DM的tag |
| ListPageAdAccount | 查询主页广告账户 | 查询page绑定的广告账户列表 |
| ModifyChatappTemplateProperties | 修改模板部分属性 | 修改模板上的部分属性。 |
| QueryMMLActive | 查询MML状态 | 查询营销消息是否生效 |
| UnbindDmAccount | 解绑Dm账号 | 解绑邮件账号 |
| UpdateWabaMmlStatus | mml嵌入式完成后，修改mml状态 | 更新waba的mml状态 |
该文章对您有帮助吗？