API概览-Chat App 消息服务-阿里云

本产品（cams/2020-06-06）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（147535001692），在专家指导下进行签名对接。

在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。

IM 群管理

API	标题	API概述
UpdateChatGroup	修改IM群信息	修改IM群信息。
ListChatGroupParticipants	IM群成员列表	获取IM群成员列表。
ListChatGroup	IM群列表	获取IM群列表。
DeleteChatGroupParticipants	删除IM群成员	删除进入IM群的成员。
DeleteChatGroupInviteLink	删除IM群邀请链接	删除IM群邀请链接。
DeleteChatGroup	删除IM群	删除已创建成功的IM群。
AddChatGroup	创建IM群	创建IM群。
AddChatGroupInviteLink	添加IM群邀请链接	添加IM群邀请链接。

流程编辑器

API	标题	API概述
ListFlowNodePrototypeV2	列举流程组件原型	列举流程组件原型。
FlowBindPhone	流程绑定号码或商家账号ID	流程绑定号码或商家账号ID。
ReadChatFlow	获取流程详情	获取流程详情。
DeleteChatFlow	删除流程	删除流程。
FlowUnbindPhone	流程解除绑定号码或商家账号ID	流程解除绑定号码或商家账号ID。
UpdateChatFlow	更新流程基础信息	根据流程编码更新流程基础信息。
FlowRebindPhone	流程重新绑定号码或商家账号ID	流程重新绑定号码或商家账号ID。
ListChatFlow	列举流程	列举流程。
ReadFlowVersion	获取流程版本	获取流程版本。
OfflineFlowVersion	下线流程版本	下线的流程版本。
UpdateFlowVersion	更新流程版本DSL数据	更新流程版本DSL数据，用于画布更新流程版本。
TriggerChatFlow	触发已上线的流程版本	触发已上线且触发器类型为手动的流程版本。
DeleteFlowVersion	删除流程版本	删除流程版本。
CreateFlowVersion	创建流程版本	通过复制流程版本创建新的流程版本。
ListFlowVersion	列举流程版本	列举流程版本。
OnlineFlowVersion	上线流程版本	上线流程版本。
CreateChatFlow	创建流程	创建流程。
CreateChatFlowByImport	创建并导入流程	创建并导入流程。
ListBindingRelationsForFlowVersion	查询已绑定的号码或商家账号ID列表	根据流程编码查询已绑定的手机号码或商家账号ID列表。
ListChatFlowTemplate	列举流程模板	列举流程模板。
GetChatFlowTemplate	查询流程模板详情	查询流程模板详情。
UpdateChatFlowLogSetting	更新流程日志设置	更新流程日志设置。
CreateChatFlowLogSetting	创建流程日志设置	创建流程日志设置。
ReadChatFlowLogSetting	查看流程日志设置	查看流程日志设置。
GetChatFlowMetric	获取ChatFlow运行数据	获取ChatFlow运行数据。

Whatsapp Flow

API	标题	API概述
PublishFlow	发布Flow	发布Flow。
UpdateFlowJSONAsset	使用JSON更新Flow内容	使用JSON更新Flow内容。
ModifyFlow	修改Flow基础信息	修改Flow基础信息。
ListFlow	查询Flow列表	查询Flow列表。
GetFlowPreviewUrl	获取Flow预览URL	获取Flow预览URL。
GetFlowJSONAssest	获取Flow的JSON内容	获取Flow的JSON格式的内容。
GetFlow	获取Flow详细信息	获取Flow详细信息。
DeprecateFlow	弃用Flow	弃用Flow。
DeleteFlow	删除Flow	删除Flow（只有在DRAFT状态的Flow才允许删除）。
CreateFlow	创建Flow	创建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	获取上传文件的鉴权信息	获取上传文件的鉴权信息。
SubmitIsvCustomerTerms	提交Isv客户的协议信息	提交Isv客户的协议信息。
GetCommerceSetting	获取号码商业设置状态	获取号码商业设置状态。
UpdateCommerceSetting	修改号码商业设置状态	修改号码商业设置状态。
ChatappEmbedSignUp	嵌入式入口	北向接口嵌入式。请在调用嵌入式SDK时使用v2版本，此接口即可忽略。

号码管理

API	标题	API概述
GetWhatsappHealthStatus	获取Whatsapp消息发送健康状态	获取不同类型的节点发送消息的健康状态。
UpdateConversationalAutomation	修改号码欢迎消息、开场白和命令	修改号码欢迎消息、开场白和命令。
GetConversationalAutomation	获取号码欢迎消息、开场白和命令	获取欢迎消息、开场白和命令。
GetPhoneEncryptionPublicKey	获取号码的加密公钥	获取号码的加密公钥。
UpdatePhoneEncryptionPublicKey	更新号码的加密公钥	更新号码的加密公钥。
UpdatePhoneMessageQrdl	修改消息二维码	修改消息二维码。
ListPhoneMessageQrdl	查询消息二维码列表	查询消息二维码列表数据。
DeletePhoneMessageQrdl	删除消息二维码	删除消息二维码。
CreatePhoneMessageQrdl	创建消息二维码	创建消息二维码。
QueryChatappPhoneNumbers	查询客户下的所有发送号码及号码状态	查询客户下的所有发送号码及号码状态。
QueryChatappBindWaba	查询客户绑定的Waba	查询客户绑定的WABA。

消息发送

API	标题	API概述
SendChatappMassMessage	批量发送ChatApp消息	批量发送ChatApp消息。
SendChatappMessage	发送ChatApp消息	发送ChatApp消息。

模板管理

API	标题	API概述
CreateChatappTemplate	创建ChatApp模板	创建消息模板，模板审核通过后可以发送消息。
ModifyChatappTemplate	修改ChatApp模板	修改消息模板。只能修改未审核以及审核不通过的模板。
ListChatappTemplate	查询ChatApp模板列表	获取消息模板列表。
GetChatappTemplateDetail	查询ChatApp模板详情	获取消息模板的详细信息。
DeleteChatappTemplate	删除ChatApp模板	删除消息模板。
ModifyChatappTemplateProperties	修改模板部分属性	修改模板上的部分属性。

商品目录

API	标题	API概述
ListProductCatalog	商品目录列表	查询Meta Business平台的目录列表。
GetWhatsappConnectionCatalog	获取Waba绑定的目录	获取Waba关联的目录。
ListProduct	商品列表	查询目录下的商品列表。

统计指标

API	标题	API概述
ListChatappMessage	查询消息清单	查询消息清单。
GetChatappPhoneNumberMetric	查询号码的发送量指标	查询WhatsApp类型通道号码的发送量指标。
EnableWhatsappROIMetric	开启Whatsapp ROI指标统计	开启Whatsapp相关指标统计。
GetChatappTemplateMetric	获取营销类型模板的相关指标	获取营销类型模板的相关指标。

其他

API	标题	API概述
GetPreValidatePhoneId	获取预校验号码的ID	预注册号码获取ID，用来在嵌入式中选择，不用重新获取验证码。