diff options
Diffstat (limited to 'data/zh_cn/cams/2020-06-06/api-docs.php')
| -rw-r--r-- | data/zh_cn/cams/2020-06-06/api-docs.php | 27774 |
1 files changed, 27774 insertions, 0 deletions
diff --git a/data/zh_cn/cams/2020-06-06/api-docs.php b/data/zh_cn/cams/2020-06-06/api-docs.php new file mode 100644 index 0000000..7353d78 --- /dev/null +++ b/data/zh_cn/cams/2020-06-06/api-docs.php @@ -0,0 +1,27774 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cams', + 'version' => '2020-06-06', + ], + 'directories' => [ + [ + 'id' => 389325, + 'title' => 'IM 群组管理', + 'type' => 'directory', + 'children' => [ + 'AddChatGroup', + 'AddChatGroupInviteLink', + 'DeleteChatGroupInviteLink', + 'DeleteChatGroupParticipants', + 'DeleteChatGroupParticipants', + 'ListChatGroup', + 'UpdateChatGroup', + 'DeleteChatGroup', + ], + ], + [ + 'id' => 389333, + 'title' => 'Messenger营销消息', + 'type' => 'directory', + 'children' => [ + 'SyncMessengerSubscriptionToken', + 'SyncMessageCampaign', + 'ListMessengerSubscriptionToken', + 'ListMessageCampaign', + 'ListCustomAudience', + 'ListChatGroupParticipants', + 'GetMessageCampaignInsights', + 'DeleteMessageCampaign', + 'CreateMessageCampaign', + 'CreateCustomAudience', + 'AddCustomAudienceUser', + ], + ], + [ + 'id' => 389345, + 'title' => '实例/Space管理', + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + 'CreateInstance', + 'DeleteInstance', + 'ListInstance', + 'QueryInstance', + 'UpdateInstance', + ], + ], + [ + 'id' => 389352, + 'title' => '流程编辑器', + 'type' => 'directory', + 'children' => [ + 'TriggerChatFlow', + ], + ], + [ + 'id' => 389354, + 'title' => 'Whatsapp Flow', + 'type' => 'directory', + 'children' => [ + 'CreateFlow', + 'ListFlow', + 'GetFlow', + 'SyncFlow', + 'ModifyFlow', + 'UpdateFlowJSONAsset', + 'GetFlowJSONAssest', + 'GetFlowPreviewUrl', + 'PublishFlow', + 'DeprecateFlow', + 'DeleteFlow', + ], + ], + [ + 'id' => 389366, + 'title' => '嵌入式相关', + 'type' => 'directory', + 'children' => [ + 'IsvGetAppId', + 'ChatappBindWaba', + 'GetPermissionByCode', + 'ChatappSyncPhoneNumber', + 'AddChatappPhoneNumber', + 'GetPhoneNumberVerificationStatus', + 'GetChatappVerifyCode', + 'ChatappVerifyAndRegister', + 'ChatappPhoneNumberRegister', + 'ChatappPhoneNumberDeregister', + 'QueryWabaBusinessInfo', + 'UpdatePhoneWebhook', + 'UpdateAccountWebhook', + 'QueryPhoneBusinessProfile', + 'ModifyPhoneBusinessProfile', + 'CreateChatappMigrationInitiate', + 'GetMigrationVerifyCode', + 'ChatappMigrationVerified', + 'ChatappMigrationRegister', + 'GetChatappUploadAuthorization', + 'GetCommerceSetting', + 'UpdateCommerceSetting', + ], + ], + [ + 'id' => 389389, + 'title' => '号码管理', + 'type' => 'directory', + 'children' => [ + 'GetWhatsappHealthStatus', + 'UpdateConversationalAutomation', + 'GetConversationalAutomation', + 'GetPhoneEncryptionPublicKey', + 'UpdatePhoneEncryptionPublicKey', + 'UpdatePhoneMessageQrdl', + 'ListPhoneMessageQrdl', + 'DeletePhoneMessageQrdl', + 'CreatePhoneMessageQrdl', + 'QueryChatappPhoneNumbers', + 'QueryChatappBindWaba', + ], + ], + [ + 'id' => 389401, + 'title' => '消息发送', + 'type' => 'directory', + 'children' => [ + 'SendChatappMassMessage', + 'SendChatappMessage', + 'WhatsappCall', + ], + ], + [ + 'id' => 389405, + 'title' => '模板管理', + 'type' => 'directory', + 'children' => [ + 'CreateChatappTemplate', + 'ModifyChatappTemplate', + 'ListChatappTemplate', + 'GetChatappTemplateDetail', + 'DeleteChatappTemplate', + ], + ], + [ + 'id' => 389411, + 'title' => '商品目录', + 'type' => 'directory', + 'children' => [ + 'ListProductCatalog', + 'GetWhatsappConnectionCatalog', + 'ListProduct', + ], + ], + [ + 'id' => 389415, + 'title' => '统计指标', + 'type' => 'directory', + 'children' => [ + 'GetChatappPhoneNumberMetric', + 'EnableWhatsappROIMetric', + 'GetChatappTemplateMetric', + ], + ], + [ + 'id' => 389419, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'GetPreValidatePhoneId', + 'CreateChatFlow', + 'CreateChatFlowByImport', + 'CreateChatFlowLogSetting', + 'CreateFlowVersion', + 'DeleteChatFlow', + 'DeleteFlowVersion', + 'FlowBindPhone', + 'FlowRebindPhone', + 'FlowUnbindPhone', + 'GetChatFlowTemplate', + 'ListBindingRelationsForFlowVersion', + 'ListChatFlow', + 'ListChatFlowTemplate', + 'ListChatappMessage', + 'ListFlowNodePrototypeV2', + 'ListFlowVersion', + 'OfflineFlowVersion', + 'OnlineFlowVersion', + 'ReadChatFlow', + 'ReadChatFlowLogSetting', + 'ReadFlowVersion', + 'UpdateChatFlow', + 'UpdateChatFlowLogSetting', + 'UpdateContactById', + 'UpdateFlowVersion', + 'GetChatappPhoneNumberSetting', + 'AddAddressRecoverSuspend', + 'AddAuditViberOpen', + 'AddContacts', + 'AddGroup', + 'AddMarketingFlow', + 'BindInstagramPage', + 'BindMessengerPage', + 'CopyTemplate', + 'CreateWhatsappConversionApi', + 'DeleteContacts', + 'DeleteContactsByIds', + 'DeleteGroupById', + 'DeleteInstagramPage', + 'DeleteMarketingFlow', + 'DeleteMessengerPage', + 'GeneratePresignedUrl', + 'GetAuditRequestByTypeUnAudit', + 'GetChatappOpenStatus', + 'GetCustomerSite', + 'GetDownloadExcelList', + 'GetFbInstagramPages', + 'GetFbMessengerPages', + 'GetGroupExist', + 'GetPledgeTemplateAddress', + 'GetViberByRequestNo', + 'GetViberPauseTimes', + 'GetWhatsappConversionApi', + 'ListAllGroups', + 'ListFacebookPosts', + 'ListFlowNodeGroup', + 'ListInstagramPage', + 'ListInstagramPosts', + 'ListMarketingFlow', + 'ListViberServiceMessage', + 'MoveContactToGroup', + 'OpenChatappService', + 'PauseMarketingFLow', + 'RemoveContactById', + 'RequestWhatsappConversionApi', + 'UpdateAuditRequest', + 'UpdateGroupName', + 'UpdateMarketingFLow', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'QueryMMLActive', + 'ListBindDmAccount', + 'UnbindDmAccount', + 'ListDmTag', + 'BindDmAccount', + 'ListDmAccount', + 'UpdateWabaMmlStatus', + 'GetChatFlowMetric', + 'ModifyChatappTemplateProperties', + 'ListPageAdAccount', + 'CreateMessengerPage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddChatGroup' => [ + 'summary' => '创建IM群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '276064', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '群组描述。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个新创建的群组', + ], + ], + [ + 'name' => 'Subject', + 'in' => 'query', + 'schema' => [ + 'description' => '群组标题。', + 'type' => 'string', + 'required' => true, + 'example' => '测试', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即为通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**。'."\n" + ."\n\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'UniqueCode' => [ + 'description' => '请求唯一Code。', + 'type' => 'string', + 'example' => '8938****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"UniqueCode\\": \\"8938****\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '创建IM群', + 'description' => '><notice>通过API创建IM群功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 您可通过此接口创建IM群，暂仅支持API方式创建IM群。'."\n" + ."\n" + .'- 创建成功后您可通过[AddChatGroupInviteLink](~~2932634~~)接口添加IM群邀请链接邀请成员进入IM群。'."\n" + ."\n" + .'- 通道类型为WhatsApp的群组成员最大数量为8人。', + ], + 'AddChatGroupInviteLink' => [ + 'summary' => '添加IM群邀请链接。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '276088', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。可通过[ListChatGroup](~~2932629~~)接口查看商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**。'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。可通过[ListChatGroup](~~2932629~~)接口查看群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'E93kdk****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'InviteLink' => [ + 'description' => '邀请链接。', + 'type' => 'string', + 'example' => 'https://chat.whatsapp.com/****', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"InviteLink\\": \\"https://chat.whatsapp.com/****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '添加IM群邀请链接', + 'description' => '><notice>通过API添加IM群邀请链接功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 在调用此接口之前，请确保您已有创建成功的IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)接口创建IM群。'."\n" + ."\n" + .'- 在调用此接口添加IM群邀请链接后，您可使用此链接邀请成员进入IM群。'."\n" + ."\n" + .'- 进入IM群的方式暂只支持通过邀请链接的方式进入。'."\n" + ."\n" + .'- 通道类型为WhatsApp的群组成员最大数量为8人。', + ], + 'DeleteChatGroupInviteLink' => [ + 'summary' => '删除IM群邀请链接。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '276100', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。可通过[ListChatGroup](~~2932629~~)接口查看商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**。'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。可通过[ListChatGroup](~~2932629~~)接口查看群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'E398****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": 1\\n}","type":"json"}]', + 'title' => '删除IM群邀请链接', + 'description' => '><notice>通过API删除IM群邀请链接功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 在调用此接口之前，请确保您创建的IM群已添加IM群邀请链接。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)、[AddChatGroupInviteLink](~~2932634~~)接口创建并添加IM群邀请链接。'."\n" + ."\n" + .'- 在删除IM群邀请链接后，IM群将无法邀请成员进入，请谨慎操作。', + ], + 'DeleteChatGroupParticipants' => [ + 'summary' => '删除进入IM群的成员。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '276101', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。可通过[ListChatGroup](~~2932629~~)接口查看商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800**', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP'."\n", + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。可通过[ListChatGroup](~~2932629~~)接口获取群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'EA93UU****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'List', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '群组成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '群组成员信息。', + 'type' => 'object', + 'properties' => [ + 'ParticipantNumber' => [ + 'description' => '群组成员。可通过[ListChatGroupParticipants](~~2932628~~)接口获取群组成员。', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Result' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": 20\\n}","type":"json"}]', + 'title' => '删除IM群成员', + 'description' => '><notice>通过API删除IM群成员功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 在调用此接口之前，请确保您创建成功的IM群已添加IM群邀请链接且已有成员通过链接进入IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)、[AddChatGroupInviteLink](~~2932634~~)接口创建并添加IM群邀请链接。'."\n" + ."\n" + .'- 删除IM群成员后，该成员将不再接收IM群的任何消息，请谨慎操作。', + ], + 'ListChatGroup' => [ + 'summary' => '获取IM群列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型的消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + [ + 'name' => 'GroupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '群组状态。取值：'."\n" + ."\n" + .'- ACTIVE：使用中。'."\n" + ."\n" + .'- INACTIVE：未激活。'."\n" + ."\n" + .'- SUSPENDED：已暂停。'."\n" + ."\n" + .'- CREATING：创建中。'."\n" + ."\n" + .'- DELETING：删除中。'."\n" + ."\n" + .'- UPDATING：更新中。', + 'type' => 'string', + 'required' => false, + 'example' => 'ACTIVE', + ], + ], + [ + 'name' => 'Subject', + 'in' => 'query', + 'schema' => [ + 'description' => '群组标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + 'Index' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'List' => [ + 'description' => '群组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '群组对象。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'test', + ], + 'BusinessNumber' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'example' => '8613800**', + ], + 'InviteLink' => [ + 'description' => '邀请链接。', + 'type' => 'string', + 'example' => 'https://chat.whatsapp.com/***', + ], + 'GroupStatus' => [ + 'description' => '群组状态。', + 'type' => 'string', + 'example' => 'ACTIVE', + ], + 'ProfilePictureFile' => [ + 'description' => '群组头像。', + 'type' => 'string', + 'example' => 'https://*********/png.jpg', + ], + 'Subject' => [ + 'description' => '群组标题。', + 'type' => 'string', + 'example' => 'This is a test subject', + ], + 'GroupId' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'example' => 'EA30d***', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Total\\": 51,\\n \\"List\\": [\\n {\\n \\"Description\\": \\"test\\",\\n \\"BusinessNumber\\": \\"8613800**\\",\\n \\"InviteLink\\": \\"https://chat.whatsapp.com/***\\",\\n \\"GroupStatus\\": \\"ACTIVE\\",\\n \\"ProfilePictureFile\\": \\"https://*********/png.jpg\\",\\n \\"Subject\\": \\"This is a test subject\\",\\n \\"GroupId\\": \\"EA30d***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'IM群列表', + 'description' => '><notice>通过API获取IM群列表功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，暂仅支持通过[AddChatGroup](~~2932518~~)接口创建IM群。'."\n" + ."\n" + .'- 此接口的非必填参数为IM群列表的筛选条件，若不填写，则查询全部IM群列表。', + ], + 'UpdateChatGroup' => [ + 'summary' => '修改IM群信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。可通过[ListChatGroup](~~2932629~~)接口查看商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**。'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型的消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。可通过[ListChatGroup](~~2932629~~)接口查看群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'EA303***', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '群组描述。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'Subject', + 'in' => 'query', + 'schema' => [ + 'description' => '群组标题。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个测试标题', + ], + ], + [ + 'name' => 'ProfilePictureFile', + 'in' => 'query', + 'schema' => [ + 'description' => '群组头像。'."\n" + ."\n" + .'> 图片限制'."\n" + .'> - 仅支持的mime type：image/jpeg'."\n" + .'> - 图片大小最大：5MB'."\n" + .'> - 图片必须是正方形，最小宽高：192 x 192', + 'type' => 'string', + 'required' => false, + 'example' => 'https://*********/img.jpg'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Result' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": 1\\n}","type":"json"}]', + 'title' => '修改IM群信息', + 'description' => '><notice>通过API修改IM群组功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + .'- 通过 API 创建WhatsApp 群组功能属于 Meta 内测功能，请联系您的商务经理申请加白。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您已有创建成功的IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)接口创建IM群。', + ], + 'DeleteChatGroup' => [ + 'summary' => '删除已创建成功的IM群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**。'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'E399**', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '影响行数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"Result\\": 1\\n}","type":"json"}]', + 'title' => '删除IM群', + 'description' => '><notice>通过API删除IM群功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)接口创建IM群。'."\n" + ."\n" + .'- IM群删除后不可恢复，请谨慎操作。', + ], + 'SyncMessengerSubscriptionToken' => [ + 'summary' => '查询Messenger订阅token。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '282388', + 'abilityTreeNodes' => [ + 'FEATUREcamsQV055M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-xi****', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '2030***', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'required' => false, + 'example' => '20399***', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Token类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'customAudience', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'TaskCode' => [ + 'description' => '任务Code', + 'type' => 'string', + 'example' => '39ss**', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '39***', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"TaskCode\\": \\"39ss**\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"39***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '同步自定义受众Token', + ], + 'SyncMessageCampaign' => [ + 'summary' => '同步查询预算。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '238**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '244**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '233**', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'OK：代表请求成功。'."\n" + ."\n" + .'其他错误码，请参见错误码列表。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"233**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '同步预算信息', + ], + 'ListMessengerSubscriptionToken' => [ + 'summary' => '查询自定义受众、订阅token列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Token类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'customAudience' => 'customAudience', + ], + 'example' => 'customAudience', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'required' => false, + 'example' => '233**', + ], + ], + [ + 'name' => 'PageKey', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页key', + 'type' => 'string', + 'required' => false, + 'example' => '2ie**', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数量。取值范围[1,1000]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '67', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'ei**', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '239***', + ], + 'TopicTitle' => [ + 'description' => 'The message\'s title', + 'type' => 'string', + 'example' => 'Example', + ], + 'CustomAudienceId' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'example' => 'Example', + ], + 'RecipientId' => [ + 'description' => 'The customer\'s Page-scoped ID (PSID)', + 'type' => 'string', + 'example' => 'Example', + ], + 'TokenExpiryTimestamp' => [ + 'description' => '口令过期时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'CreationTimestamp' => [ + 'description' => '口令的创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'NotificationMessagesToken' => [ + 'description' => '客户的公共主页范围编号', + 'type' => 'string', + 'example' => 'Example', + ], + 'NotificationMessagesReoptin' => [ + 'description' => '重订阅状态', + 'type' => 'string', + 'example' => 'Example', + ], + 'NextEligibleTime' => [ + 'description' => '应用可向该接收人发送下一条营销消息的时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'NotificationMessagesTimezone' => [ + 'description' => '客户所在时区', + 'type' => 'string', + 'example' => 'Example', + ], + 'UserTokenStatus' => [ + 'description' => '口令状态', + 'type' => 'string', + 'example' => 'Example', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NextPage' => [ + 'description' => '下一页标识，查询下一页时需要传入', + 'type' => 'string', + 'example' => '3399***', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"ei**\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"239***\\",\\n \\"TopicTitle\\": \\"Example\\",\\n \\"CustomAudienceId\\": \\"Example\\",\\n \\"RecipientId\\": \\"Example\\",\\n \\"TokenExpiryTimestamp\\": 172546854885,\\n \\"CreationTimestamp\\": 172546854885,\\n \\"NotificationMessagesToken\\": \\"Example\\",\\n \\"NotificationMessagesReoptin\\": \\"Example\\",\\n \\"NextEligibleTime\\": 172546854885,\\n \\"NotificationMessagesTimezone\\": \\"Example\\",\\n \\"UserTokenStatus\\": \\"Example\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"NextPage\\": \\"3399***\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询自定义受众、订阅token列表', + ], + 'ListMessageCampaign' => [ + 'summary' => '查询预算列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => false, + 'example' => '239**', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '预算状态', + 'type' => 'string', + 'required' => false, + 'example' => 'AVAILABLE', + ], + ], + [ + 'name' => 'CampaignName', + 'in' => 'query', + 'schema' => [ + 'description' => '预算名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test-campaign', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页参数对象', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '55', + ], + 'Index' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '7', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '预算ID', + 'type' => 'string', + 'required' => false, + 'example' => '233**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '23**', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '238***', + ], + 'Status' => [ + 'description' => '预算状态', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'CampaignId' => [ + 'description' => '预算ID', + 'type' => 'string', + 'example' => '233**', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173029392838', + ], + 'AdAccountId' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'example' => '2339**', + ], + 'CampaignName' => [ + 'description' => '预算名称', + 'type' => 'string', + 'example' => 'campaign-name', + ], + 'Budget' => [ + 'description' => '预算', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '62', + ], + 'BudgetType' => [ + 'description' => '预算类型。', + 'type' => 'string', + 'example' => 'daily', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'Example', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"23**\\",\\n \\"Total\\": 70,\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"238***\\",\\n \\"Status\\": \\"AVAILABLE\\",\\n \\"CampaignId\\": \\"233**\\",\\n \\"CreateTime\\": 173029392838,\\n \\"AdAccountId\\": \\"2339**\\",\\n \\"CampaignName\\": \\"campaign-name\\",\\n \\"Budget\\": 62,\\n \\"BudgetType\\": \\"daily\\"\\n }\\n ],\\n \\"Code\\": \\"Example\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询预算列表', + ], + 'ListCustomAudience' => [ + 'summary' => '自定义受众列表查询。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '3939**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => false, + 'example' => '339**', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Token类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'custom', + ], + ], + [ + 'name' => 'CustomAudienceName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众名称', + 'type' => 'string', + 'required' => false, + 'example' => 'name', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '95', + ], + 'Index' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '40', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'required' => false, + 'example' => '239**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '39**', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '239**', + ], + 'Status' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'None', + ], + 'CustomAudienceId' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'example' => '339**', + ], + 'CustomAudienceName' => [ + 'description' => '自定义受众名称', + 'type' => 'string', + 'example' => 'custom audience name', + ], + 'TokenType' => [ + 'description' => 'Token类型。', + 'type' => 'string', + 'example' => 'custom', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'desc', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1720356898', + ], + 'AdAccountId' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'example' => '339**', + ], + 'UpdateTime' => [ + 'description' => '更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'TokenTotal' => [ + 'description' => 'token数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UploadType' => [ + 'description' => '用户上传类型', + 'type' => 'string', + 'example' => 'excel', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"39**\\",\\n \\"Total\\": 69,\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"239**\\",\\n \\"Status\\": \\"None\\",\\n \\"CustomAudienceId\\": \\"339**\\",\\n \\"CustomAudienceName\\": \\"custom audience name\\",\\n \\"TokenType\\": \\"custom\\",\\n \\"Description\\": \\"desc\\",\\n \\"CreateTime\\": 1720356898,\\n \\"AdAccountId\\": \\"339**\\",\\n \\"UpdateTime\\": 51,\\n \\"TokenTotal\\": 70,\\n \\"UploadType\\": \\"excel\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '自定义受众查询', + ], + 'ListChatGroupParticipants' => [ + 'summary' => '获取IM群成员列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。可通过[ListChatGroup](~~2932629~~)接口查看商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'> 暂仅支持WhatsApp通道类型消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。可通过[ListChatGroup](~~2932629~~)接口查看群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'EA939****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-k***', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'Index' => [ + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'List' => [ + 'description' => '群组成员列表。', + 'type' => 'array', + 'items' => [ + 'description' => '群组成员信息。', + 'type' => 'object', + 'properties' => [ + 'ParticipantNumber' => [ + 'description' => '群组成员。', + 'type' => 'string', + 'example' => '861382***', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Total\\": 8,\\n \\"List\\": [\\n {\\n \\"ParticipantNumber\\": \\"861382***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'IM群成员列表', + 'description' => '><notice>通过API获取IM群成员列表功能属于Meta内测功能，请联系您的商务经理申请加白。></notice>'."\n" + .'- 在调用此接口之前，请确保您创建成功的IM群已添加IM群邀请链接且已有成员通过链接进入IM群。'."\n" + ."\n" + .'- 若您没有已创建成功的IM群，可通过[AddChatGroup](~~2932518~~)、[AddChatGroupInviteLink](~~2932634~~)接口创建并添加IM群邀请链接。', + ], + 'GetMessageCampaignInsights' => [ + 'summary' => '查询预算指标。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '要查询的页码。', + 'type' => 'string', + 'required' => true, + 'example' => '323**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '23***', + ], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '预算ID', + 'type' => 'string', + 'required' => true, + 'example' => '23**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 's39**', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'MarketingMessagesLinkBtnClick' => [ + 'description' => '用户在营销消息中执行点击或轻触操作的次数，这些操作将引导用户前往广告主指定的 Meta 技术站内或站外目标位置。这项指标不包括发送到欧洲、阿根廷、土耳其、韩国和日本的消息。', + 'type' => 'string', + 'example' => '268', + ], + 'MarketingMessagesSpend' => [ + 'description' => '在整个投放期为消息营销活动、消息组或消息花费的总金额。', + 'type' => 'string', + 'example' => '38.87', + ], + 'MarketingMessagesDelivered' => [ + 'description' => '商家向用户发送并成功送达的消息数量。部分消息可能无法送达，例如用户设备无法使用时。这项指标不包括送达至欧洲和日本的消息。在某些情况下，该指标可能为预估值，且由于数据处理过程中存在细微差异，其值可能与您结算单上显示的数据不一致。', + 'type' => 'string', + 'example' => '2755', + ], + 'DateStop' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2025-07-29', + ], + 'MarketingMessagesReadRate' => [ + 'description' => '已读消息数除以送达消息数。系统可能未捕捉到部分消息的已读状态，例如当客户关闭已读回执时。这项指标不包括发送到欧洲和日本的消息。', + 'type' => 'string', + 'example' => '79.419238', + ], + 'MarketingMessagesCostPerDelivered' => [ + 'description' => '每条送达消息的平均费用。', + 'type' => 'string', + 'example' => '2755', + ], + 'DateStart' => [ + 'description' => '开始时间', + 'type' => 'string', + 'example' => '2025-07-01', + ], + 'MarketingMessagesDeliveryRate' => [ + 'description' => '消息到达率。', + 'type' => 'string', + 'example' => '79.419238', + ], + 'MarketingMessagesLinkBtnClickRate' => [ + 'description' => '获得链接点击的送达消息占送达消息总数的百分比。这项指标不包括发送到欧洲、阿根廷、土耳其、韩国和日本的消息。', + 'type' => 'string', + 'example' => '79.419238', + ], + 'MarketingMessagesCostPerLinkBtnClick' => [ + 'description' => '每次消息链接点击的平均费用。这项指标不包括发送到欧洲、阿根廷、土耳其、韩国和日本的消息。', + 'type' => 'string', + 'example' => '268', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"s39**\\",\\n \\"Data\\": [\\n {\\n \\"MarketingMessagesLinkBtnClick\\": \\"268\\",\\n \\"MarketingMessagesSpend\\": \\"38.87\\",\\n \\"MarketingMessagesDelivered\\": \\"2755\\",\\n \\"DateStop\\": \\"2025-07-29\\",\\n \\"MarketingMessagesReadRate\\": \\"79.419238\\",\\n \\"MarketingMessagesCostPerDelivered\\": \\"2755\\",\\n \\"DateStart\\": \\"2025-07-01\\",\\n \\"MarketingMessagesDeliveryRate\\": \\"79.419238\\",\\n \\"MarketingMessagesLinkBtnClickRate\\": \\"79.419238\\",\\n \\"MarketingMessagesCostPerLinkBtnClick\\": \\"268\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取营销活动预算的成效分析数据', + ], + 'DeleteMessageCampaign' => [ + 'summary' => '删除发送Messenger消息创建的营销活动预算。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '293***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '293**', + ], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '预算ID', + 'type' => 'string', + 'required' => true, + 'example' => '329**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '239***', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"239***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除messenger消息营销活动预算', + ], + 'CreateMessageCampaign' => [ + 'summary' => '创建预算。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '238***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '3993**', + ], + ], + [ + 'name' => 'BudgetType', + 'in' => 'query', + 'schema' => [ + 'description' => '预算类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'daily' => 'daily', + 'lifetime' => 'lifetime', + ], + 'example' => 'daily', + ], + ], + [ + 'name' => 'Budget', + 'in' => 'query', + 'schema' => [ + 'description' => '预算（美分）', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '300', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '预算名称', + 'type' => 'string', + 'required' => true, + 'example' => 'Example', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'Example', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'Example', + ], + 'CampaignId' => [ + 'description' => '预算ID', + 'type' => 'string', + 'example' => '39***', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"Example\\",\\n \\"RequestId\\": \\"Example\\",\\n \\"CampaignId\\": \\"39***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建预算', + ], + 'CreateCustomAudience' => [ + 'summary' => '创建自定义受众。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '23**', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众名称', + 'type' => 'string', + 'required' => true, + 'example' => 'audience name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述', + 'type' => 'string', + 'required' => false, + 'example' => 'desc', + ], + ], + [ + 'name' => 'UploadType', + 'in' => 'query', + 'schema' => [ + 'description' => '用户上传类型', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'excel' => 'excel', + 'intf' => 'intf', + ], + 'example' => 'excel', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径', + 'type' => 'string', + 'required' => false, + 'example' => 'bucket/file.xlsx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'CustomAudienceId' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'example' => '393**', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'dd**', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"CustomAudienceId\\": \\"393**\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"dd**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建自定义受众', + ], + 'AddCustomAudienceUser' => [ + 'summary' => '增加自定义受众。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '282383', + 'abilityTreeNodes' => [ + 'FEATUREcamsQV055M', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId'."\n" + ."\n" + .'- 直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '239**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '3939**', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义受众ID', + 'type' => 'string', + 'required' => true, + 'example' => '399**', + ], + ], + [ + 'name' => 'Users', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '用户列表', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'Email' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => 'Example', + ], + 'Phone' => [ + 'description' => '手机号', + 'type' => 'string', + 'required' => false, + 'example' => 'Example', + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'EstimatedNumTotal', + 'in' => 'query', + 'schema' => [ + 'description' => '预估号码数据', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '26', + ], + ], + [ + 'name' => 'BatchLastFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '批次最后标记', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '39**', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"39**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '增加自定义受众', + 'description' => '增加的自定义受众用户提交到meta后，meta如果匹配成功的用户量少于100，他们会扔掉这次的匹配数据，这样做是为了防止提交的号码与token做比对，从而得到直接关系，接口最多一次可以传入10000条用户数据', + ], + 'ChangeResourceGroup' => [ + 'summary' => '资源转组。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '206681', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源类型', + 'description' => '资源类型', + 'type' => 'string', + 'required' => false, + 'example' => 'template', + 'default' => 'Instance', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源Id', + 'description' => '资源Id', + 'type' => 'string', + 'required' => true, + 'example' => 'cas-ivauto-hppr74', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '目标资源组', + 'description' => '目标资源组', + 'type' => 'string', + 'required' => true, + 'example' => '-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermission.ChangeResourceGroup', + 'errorMessage' => 'You are not authorized to change resourcegroup', + ], + [ + 'errorCode' => 'MissingParameter.RegionId', + 'errorMessage' => 'The RegionId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceId', + 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'MissingParameter.ResourceGroupId', + 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', + ], + [ + 'errorCode' => 'InvalidResourceGroup', + 'errorMessage' => 'The specified ResourceGroupId is invalid', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred while processing your request', + ], + [ + 'errorCode' => 'ResourceNotFound', + 'errorMessage' => ' The specified resource is not found', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\"\\n}","type":"json"}]', + 'title' => '资源转组', + ], + 'CreateInstance' => [ + 'summary' => '新建实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205982', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型', + 'type' => 'string', + 'required' => true, + 'example' => 'VIBER', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'viber_ins', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'ins', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的企业资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'OfficeAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '企业地址。', + 'type' => 'string', + 'required' => false, + 'example' => '长沙麓谷', + ], + ], + [ + 'name' => 'ContactMail', + 'in' => 'query', + 'schema' => [ + 'description' => '联系邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => '国家码', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FacebookBmId', + 'in' => 'query', + 'schema' => [ + 'description' => 'FacebookBmId', + 'type' => 'string', + 'required' => false, + 'example' => '393992929', + ], + ], + [ + 'name' => 'IsvTerms', + 'in' => 'query', + 'schema' => [ + 'description' => 'Isv/Client协议文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://a.com/1.pdf', + ], + ], + [ + 'name' => 'IsConfirmAudit', + 'in' => 'query', + 'schema' => [ + 'description' => '是否确认审核', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2992939*****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ins', + ], + 'ResourceRegionId' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => '2999292', + ], + 'InstanceDescription' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'example' => 'des', + ], + 'SubmitTime' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'example' => '示例值', + ], + 'ChannelType' => [ + 'description' => '通道类型。', + 'type' => 'string', + 'example' => '示例值', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '请求是否成功，返回值如下：true：请求成功 false：请求失败', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"2992939*****\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Data\\": {\\n \\"InstanceName\\": 0,\\n \\"ResourceRegionId\\": \\"示例值示例值\\",\\n \\"InstanceId\\": \\"2999292\\",\\n \\"InstanceDescription\\": \\"des\\",\\n \\"SubmitTime\\": \\"示例值\\",\\n \\"ChannelType\\": \\"示例值\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '新建实例', + ], + 'DeleteInstance' => [ + 'summary' => '删除实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205980', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2399393****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3993939******', + ], + 'Message' => [ + 'description' => '响应信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"3993939******\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '删除实例', + ], + 'ListInstance' => [ + 'summary' => '查询实例列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205978', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值：'."\n" + ."\n" + .'- **whatsapp**。'."\n" + ."\n" + .'- **messenger**。'."\n" + .'- **instagram**。'."\n" + ."\n" + .'<props="intl">- **viber**。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'VIBER', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'viber_ins', + ], + ], + [ + 'name' => 'SubmitTime', + 'in' => 'query', + 'schema' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-12-12 00:00:00', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '87', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '92', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例所在的企业资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。仅支持非阿里云主机。', + 'type' => 'string', + 'required' => false, + 'example' => 'r-uf6wd7pkyjwxvlxfhk', + ], + ], + [ + 'name' => 'FilterStr', + 'in' => 'query', + 'schema' => [ + 'description' => '过滤条件', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'TotalCount' => [ + 'description' => '满足条件的记录总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2993*****', + ], + 'Message' => [ + 'description' => '接口返回信息', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'CountryId' => [ + 'description' => '国家ID。', + 'type' => 'string', + 'example' => '1', + ], + 'ContactMail' => [ + 'description' => '联系邮箱', + 'type' => 'string', + 'example' => 'ma**@gmail.com', + ], + 'ResourceRegionId' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'example' => '11', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => '12', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => '29339****', + ], + 'OfficeAddress' => [ + 'description' => '企业地址。', + 'type' => 'string', + 'example' => '示例值', + ], + 'SubmitTime' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'example' => '2023-12-12 00:00:00', + ], + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'viber_ins', + ], + 'CustSpaceId' => [ + 'description' => '客户SpaceID。', + 'type' => 'string', + 'example' => 'dad-gf**', + ], + 'IsvTerms' => [ + 'description' => 'Isv/Client协议文件名。', + 'type' => 'string', + 'example' => 'aa', + ], + 'FacebookBmId' => [ + 'description' => '绑定facebook的id', + 'type' => 'string', + 'example' => '1', + ], + 'InstanceDescription' => [ + 'description' => '实例描述信息。', + 'type' => 'string', + 'example' => 'ins', + ], + 'ChannelType' => [ + 'description' => '通道类型。', + 'type' => 'string', + 'example' => 'VIBER', + ], + 'State' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'published', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"TotalCount\\": 15,\\n \\"RequestId\\": \\"2993*****\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Data\\": [\\n {\\n \\"CountryId\\": \\"1\\",\\n \\"ContactMail\\": \\"ma**@gmail.com\\",\\n \\"ResourceRegionId\\": \\"11\\",\\n \\"ResourceGroupId\\": \\"12\\",\\n \\"InstanceId\\": \\"29339****\\",\\n \\"OfficeAddress\\": \\"示例值\\",\\n \\"SubmitTime\\": \\"2023-12-12 00:00:00\\",\\n \\"InstanceName\\": \\"viber_ins\\",\\n \\"CustSpaceId\\": \\"dad-gf**\\",\\n \\"IsvTerms\\": \\"aa\\",\\n \\"FacebookBmId\\": \\"1\\",\\n \\"InstanceDescription\\": \\"ins\\",\\n \\"ChannelType\\": \\"VIBER\\",\\n \\"State\\": \\"published\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询实例列表', + ], + 'QueryInstance' => [ + 'summary' => '查询实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205979', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例id', + 'type' => 'string', + 'required' => true, + 'example' => '9293938****', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '响应信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '29kskkd******', + ], + 'Data' => [ + 'description' => '调用成功时，返回的数据。', + 'type' => 'object', + 'properties' => [ + 'CountryId' => [ + 'description' => '国家编码ID。'."\n" + ."\n" + .'> 详细国家编码，请参见[国家编码](~~608210~~)。', + 'type' => 'string', + 'example' => '1', + ], + 'ContactMail' => [ + 'description' => '联系人邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'CustType' => [ + 'description' => '客户类型', + 'type' => 'string', + 'example' => '01', + ], + 'ResourceRegionId' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'example' => '1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组id', + 'type' => 'string', + 'example' => '111', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => '293939*****', + ], + 'OfficeAddress' => [ + 'description' => '企业地址。', + 'type' => 'string', + 'example' => '长沙麓谷', + ], + 'SubmitTime' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'example' => '140092992', + ], + 'InstanceName' => [ + 'description' => '关联实例的名称。', + 'type' => 'string', + 'example' => 'viber_ins', + ], + 'IsvTerms' => [ + 'description' => 'Isv/Client协议文件名。', + 'type' => 'string', + 'example' => 'https://alibaba.com/1.pdf', + ], + 'FacebookBmId' => [ + 'description' => 'FacebookBmId', + 'type' => 'string', + 'example' => '399298882', + ], + 'InstanceDescription' => [ + 'description' => '实例描述信息。', + 'type' => 'string', + 'example' => 'ins', + ], + 'ChannelType' => [ + 'description' => '通道类型。', + 'type' => 'string', + 'example' => 'VIBER', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"NULL\\",\\n \\"RequestId\\": \\"29kskkd******\\",\\n \\"Data\\": {\\n \\"CountryId\\": \\"1\\",\\n \\"ContactMail\\": \\"[email protected]\\",\\n \\"CustType\\": \\"01\\",\\n \\"ResourceRegionId\\": \\"1\\",\\n \\"ResourceGroupId\\": \\"111\\",\\n \\"InstanceId\\": \\"293939*****\\",\\n \\"OfficeAddress\\": \\"长沙麓谷\\",\\n \\"SubmitTime\\": \\"140092992\\",\\n \\"InstanceName\\": \\"viber_ins\\",\\n \\"IsvTerms\\": \\"https://alibaba.com/1.pdf\\",\\n \\"FacebookBmId\\": \\"399298882\\",\\n \\"InstanceDescription\\": \\"ins\\",\\n \\"ChannelType\\": \\"VIBER\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询实例', + ], + 'UpdateInstance' => [ + 'summary' => '修改实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '205981', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，实例的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => '82838838****', + 'default' => '', + ], + ], + [ + 'name' => 'InstanceName', + 'in' => 'query', + 'schema' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'viber_ins', + ], + ], + [ + 'name' => 'InstanceDescription', + 'in' => 'query', + 'schema' => [ + 'description' => '实例描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'ins', + ], + ], + [ + 'name' => 'OfficeAddress', + 'in' => 'query', + 'schema' => [ + 'description' => '企业地址。', + 'type' => 'string', + 'required' => false, + 'example' => '长沙麓谷', + ], + ], + [ + 'name' => 'ContactMail', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CountryId', + 'in' => 'query', + 'schema' => [ + 'description' => '国家编码ID。'."\n" + ."\n" + .'> 详细国家编码，请参见[国家编码](~~608210~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FacebookBmId', + 'in' => 'query', + 'schema' => [ + 'description' => 'fb bmId', + 'type' => 'string', + 'required' => false, + 'example' => '3939982828', + ], + ], + [ + 'name' => 'IsvTerms', + 'in' => 'query', + 'schema' => [ + 'description' => 'Isv/Client协议文件名。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aa.com/a.pdf', + ], + ], + [ + 'name' => 'IsConfirmAudit', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自动确认', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'ins', + ], + 'ResourceRegionId' => [ + 'description' => '资源所属地域。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'InstanceId' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'example' => '293992992', + ], + 'InstanceDescription' => [ + 'description' => '实例描述信息。', + 'type' => 'string', + 'example' => 'des', + ], + 'ChannelType' => [ + 'description' => '音轨类型。', + 'type' => 'string', + 'example' => 'VIBER', + ], + 'SubmitTime' => [ + 'description' => '提交时间。', + 'type' => 'string', + 'example' => '2020-12-01 00:00:00', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => 'des', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Data\\": {\\n \\"InstanceName\\": \\"ins\\",\\n \\"ResourceRegionId\\": \\"示例值示例值\\",\\n \\"InstanceId\\": \\"293992992\\",\\n \\"InstanceDescription\\": \\"des\\",\\n \\"ChannelType\\": \\"VIBER\\",\\n \\"SubmitTime\\": \\"2020-12-01 00:00:00\\",\\n \\"Description\\": \\"des\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '修改实例', + ], + 'TriggerChatFlow' => [ + 'summary' => '触发已上线且触发器类型为手动的流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250331', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************'."\n", + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '入参，Key-Value格式，其Key需要与您在流程开始节点配置的入参策略相匹配。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击触发器类型为手动的流程名称进入画布编排界面查看开始节点的变量名称。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "my_biz_data_0": "hi",'."\n" + .' "my_biz_data_1": "1024"'."\n" + .'}', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义事件唯一ID，用于触发幂等，请勿携带任何业务语义，触发后您可以在流程中获取到此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'c68622e6-5f0d-c8a4-af41-e949c2a7580e'."\n", + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义外部系统流水号，用于关联外部业务系统流水，触发后您可以在流程中获取到此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '8d4acf7e-e360-eb83-6d74-fcf9c4538fda'."\n", + ], + ], + [ + 'name' => 'ClaimTimeMillis', + 'in' => 'query', + 'schema' => [ + 'description' => '声明事件发生时刻，即为流程触发时刻，一般为请求构造时刻，时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731502129000', + ], + ], + [ + 'name' => 'DiscardTimeMillis', + 'in' => 'query', + 'schema' => [ + 'description' => '声明事件被丢弃时刻，即为触发流程的过期时刻，若声明了该字段，发起请求后响应时间超过此时刻，流程触发将被取消，时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731502729000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '触发已上线的流程版本', + 'description' => '- 您可调用此接口触发已上线且触发器类型为手动的流程版本，也可在[营销活动管理](https://chatapp.console.aliyun.com/MarketingActivityManagement)界面通过营销活动关联的触发器类型为手动的流程进行流程触发。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您创建的流程触发器类型为手动且状态为已上线。'."\n" + ."\n" + .'- 若您创建的触发器类型为手动的流程没有状态为已上线的版本，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动上线流程版本或通过[OnlineFlowVersion](~~2937203~~)接口上线流程版本。'."\n" + ."\n" + .'- 触发已上线的流程后，若您的流程含有消息发送、函数调用等产生对应云产品费用的组件，请确保在使用该接口前，已充分了解相关产品的收费方式和价格。', + 'requestParamsDescription' => '无。', + ], + 'CreateFlow' => [ + 'summary' => '创建Flow。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200947', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'flow-001', + ], + ], + [ + 'name' => 'Categories', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目录。', + 'type' => 'array', + 'items' => [ + 'description' => '类目信息', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CUSTOMER_SUPPORT' => 'CUSTOMER_SUPPORT', + 'OTHER' => 'OTHER', + 'SIGN_IN' => 'SIGN_IN', + 'SIGN_UP' => 'SIGN_UP', + 'APPOINTMENT_BOOKING' => 'APPOINTMENT_BOOKING', + 'LEAD_GENERATION' => 'LEAD_GENERATION', + 'SURVEY' => 'SURVEY', + 'CONTACT_US' => 'CONTACT_US', + ], + 'example' => 'SIGN_UP', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-alk21lk3j2k3lj', + ], + ], + [ + 'name' => 'EndpointUri', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the WA Flow Endpoint', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '333993838***', + ], + 'Categories' => [ + 'description' => '目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Flow目录信息。', + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"FlowId\\": \\"333993838***\\",\\n \\"Categories\\": [\\n \\"SIGN_UP\\"\\n ],\\n \\"FlowName\\": \\"test1\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '创建Flow', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListFlow' => [ + 'summary' => '查询Flow列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200950', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + 'FEATUREcamsFP3L4Z', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'flow-21101', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Index' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-sa2ksj21jksd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****', + ], + 'Categories' => [ + 'description' => '目录。', + 'type' => 'array', + 'items' => [ + 'description' => 'Flow目录。', + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'example' => 'flow-02020', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"1612C226-E271-4CFE-9F18-4066D550F91B\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"FlowId\\": \\"92675332812643****\\",\\n \\"Categories\\": [\\n \\"SIGN_UP\\"\\n ],\\n \\"FlowName\\": \\"flow-02020\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询Flow列表', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetFlow' => [ + 'summary' => '获取Flow详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201003', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程ID，即为在创建WhatsApp Flow时通过[CreateFlow](~~2638742~~)接口返回的FlowId。', + 'type' => 'string', + 'required' => true, + 'example' => '333993838***'."\n", + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575'."\n", + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'Flow的状态。取值：'."\n" + .'- PUBLISHED：已发布。'."\n" + .'- DRAFT：草稿。'."\n" + .'- DEPRECATED：已弃用。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DRAFT', + ], + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****', + ], + 'PreviewUrl' => [ + 'description' => '临时预览链接。', + 'type' => 'string', + 'example' => 'https://pre-url', + ], + 'EndpointUri' => [ + 'description' => 'The URL of the WA Flow Endpoint', + 'type' => 'string', + 'example' => 'http://abc.com', + ], + 'JSONVersion' => [ + 'description' => 'JSON版本信息。', + 'type' => 'string', + 'example' => '2.1', + ], + 'Categories' => [ + 'description' => '目录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '目录。', + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'example' => 'flow_001', + ], + 'DataApiVersion' => [ + 'description' => 'API版本信息。', + 'type' => 'string', + 'example' => '3.0', + ], + 'PreviewUrlExpires' => [ + 'description' => '预览URL的过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700617436633'."\n", + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"DAC72B08-3327-33EF-BEDC-8EC3E83A6575\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"Status\\": \\"DRAFT\\",\\n \\"FlowId\\": \\"92675332812643****\\",\\n \\"PreviewUrl\\": \\"https://pre-url\\",\\n \\"EndpointUri\\": \\"http://abc.com\\",\\n \\"JSONVersion\\": \\"2.1\\",\\n \\"Categories\\": [\\n \\"SIGN_UP\\"\\n ],\\n \\"FlowName\\": \\"flow_001\\",\\n \\"DataApiVersion\\": \\"3.0\\",\\n \\"PreviewUrlExpires\\": 1700617436633\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取Flow详细信息', + 'description' => '- 在调用此接口前，请确保您已有成功创建的WhatsApp Flow。'."\n" + ."\n" + .'- 若您没有已成功创建的WhatsApp Flow，可调用[CreateFlow](~~2638742~~)接口创建WhatsApp Flow。'."\n" + ."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SyncFlow' => [ + 'summary' => '同步meta流程', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '通道实例', + 'description' => '通道实例', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-kei****', + 'default' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '接口返回信息', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '172D586A-5E9D-11C8-BED3-7E4A0***', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"172D586A-5E9D-11C8-BED3-7E4A0***\\",\\n \\"Code\\": 0,\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '同步Whatsapp flow', + ], + 'ModifyFlow' => [ + 'summary' => '修改Flow基础信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200949', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Flow-**001', + ], + ], + [ + 'name' => 'Categories', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '目录。', + 'type' => 'array', + 'items' => [ + 'description' => 'Flow目录信息。', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"烟雾量大/合适\\"]', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程id', + 'type' => 'string', + 'required' => false, + 'example' => '21231232312', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-1sdkjwen2', + ], + ], + [ + 'name' => 'EndpointUri', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the WA Flow Endpoint', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Schema of Response。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D******', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****'."\n", + ], + 'EndpointUri' => [ + 'description' => 'The URL of the WA Flow Endpoint', + 'type' => 'string', + 'example' => 'http://www.abc.com', + ], + 'Categories' => [ + 'description' => 'Flow目录。', + 'type' => 'array', + 'items' => [ + 'description' => 'Flow目录。', + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'description' => 'Flow名称。', + 'type' => 'string', + 'example' => 'flow_001', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"1612C226-E271-4CFE-9F18-4066D******\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"FlowId\\": \\"92675332812643****\\\\n\\",\\n \\"EndpointUri\\": \\"http://www.abc.com\\",\\n \\"Categories\\": [\\n \\"SIGN_UP\\"\\n ],\\n \\"FlowName\\": \\"flow_001\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '修改Flow基础信息', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateFlowJSONAsset' => [ + 'summary' => '使用JSON更新Flow内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200972', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程id', + 'type' => 'string', + 'required' => true, + 'example' => '2322334234234', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.xxxx.com/files/document.json', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-sdk2j3dnxxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"FlowId\\": \\"92675332812643****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '使用JSON更新Flow内容', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetFlowJSONAssest' => [ + 'summary' => '获取Flow的JSON格式的内容。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201000', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程ID，您在通过[CreateFlow](~~2638742~~)接口创建Flow时返回的FlowId。', + 'type' => 'string', + 'required' => false, + 'example' => '17b6****************************', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****', + ], + 'FilePath' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'example' => 'https://bucket-*****-ap-southeast-1.aliyuncs.com/9658820125168****.json', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"FlowId\\": \\"92675332812643****\\",\\n \\"FilePath\\": \\"https://bucket-*****-ap-southeast-1.aliyuncs.com/9658820125168****.json\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取Flow的JSON内容', + 'description' => '- 在调用此接口前，请确保您已有成功创建的WhatsApp Flow。'."\n" + ."\n" + .'- 若您没有已成功创建的WhatsApp Flow，可通过[CreateFlow](~~2638742~~)接口创建WhatsApp Flow。'."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetFlowPreviewUrl' => [ + 'summary' => '获取Flow预览URL。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200995', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程ID，即为在创建WhatsApp Flow时通过[CreateFlow](~~2638742~~)接口返回的FlowId。', + 'type' => 'string', + 'required' => true, + 'example' => '333993838***'."\n", + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '92675332812643****', + ], + 'PreviewUrl' => [ + 'description' => '临时预览链接。', + 'type' => 'string', + 'example' => 'https://business.facebook.com/****', + ], + 'PreviewUrlExpires' => [ + 'description' => '预览URL的过期时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700617436633', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"FlowId\\": \\"92675332812643****\\",\\n \\"PreviewUrl\\": \\"https://business.facebook.com/****\\",\\n \\"PreviewUrlExpires\\": 1700617436633\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取Flow预览URL', + 'description' => '- 您在创建WhatsApp Flow后，可通过此接口获取流程预览URL，以预览您的流程。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有成功创建的WhatsApp Flow。'."\n" + ."\n" + .'- 若您没有已成功创建的WhatsApp Flow，可调用[CreateFlow](~~2638742~~)接口创建WhatsApp Flow。'."\n" + ."\n\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'PublishFlow' => [ + 'summary' => '发布Flow。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201007', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '流程ID，即为在创建WhatsApp Flow时通过[CreateFlow](~~2638742~~)接口返回的FlowId。', + 'type' => 'string', + 'required' => true, + 'example' => '333993838***', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575'."\n", + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"DAC72B08-3327-33EF-BEDC-8EC3E83A6575\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '发布Flow', + 'description' => '- 在调用此接口前，请确保您已有成功创建的WhatsApp Flow。'."\n" + ."\n" + .'- 若您没有成功创建的WhatsApp Flow，请通过[CreateFlow](~~2638742~~)接口创建WhatsApp Flow。'."\n" + ."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeprecateFlow' => [ + 'summary' => '弃用Flow。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201008', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流id', + 'type' => 'string', + 'required' => true, + 'example' => '1212323', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-awsd12312o3j', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '弃用Flow', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteFlow' => [ + 'summary' => '删除Flow（只有在DRAFT状态的Flow才允许删除）。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201009', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作流ID。', + 'type' => 'string', + 'required' => true, + 'example' => '346699123', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-awlkj23a09jd', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '权限校验失败详情 ', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '删除Flow', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'IsvGetAppId' => [ + 'summary' => 'ISV获取App ID。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161013', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值：'."\n" + ."\n" + .'- whatsapp：whatsapp。', + 'type' => 'string', + 'required' => true, + 'example' => 'whatsapp', + ], + ], + [ + 'name' => 'IntlVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '版本', + 'type' => 'string', + 'required' => false, + 'example' => '2', + 'default' => '2', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'schema' => [ + 'description' => '权限', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3***', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'AppId' => [ + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '23hr3v****', + ], + 'ConfigId' => [ + 'description' => '配置项ID。', + 'type' => 'string', + 'example' => '28972951817****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"744c4b5c79c9432497a075bdfca3***\\",\\n \\"Message\\": \\"null\\",\\n \\"AppId\\": \\"23hr3v****\\",\\n \\"ConfigId\\": \\"28972951817****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取App ID', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappBindWaba' => [ + 'summary' => '北向接口绑定Waba。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161150', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + ], + 'parameters' => [ + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'waba Id。', + 'type' => 'string', + 'required' => true, + 'example' => '33993***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'CustSpaceId' => [ + 'description' => '客户SpaceID。', + 'type' => 'string', + 'example' => 'C0202939293****', + ], + 'WabaId' => [ + 'description' => 'waba Id。', + 'type' => 'string', + 'example' => '293982****', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"CustSpaceId\\": \\"C0202939293****\\",\\n \\"WabaId\\": \\"293982****\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '绑定waba', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetPermissionByCode' => [ + 'summary' => '根据嵌入式得到的Code获取授权权限。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '201033', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '授权Code信息', + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-isj23ljd912', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '权限', + 'type' => 'array', + 'items' => [ + 'description' => '权限', + 'type' => 'string', + 'required' => false, + 'example' => 'whatsapp_business_messaging', + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'No', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"No\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '根据嵌入式得到的Code获取授权权限', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappSyncPhoneNumber' => [ + 'summary' => '同步号码信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161959', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'PhoneNumbers' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对象。', + 'type' => 'object', + 'properties' => [ + 'VerifiedName' => [ + 'description' => '号码名称。', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Status' => [ + 'description' => '号码状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MIGRATED' => 'MIGRATED', + 'FLAGGED' => 'FLAGGED', + 'DISCONNECTED' => 'DISCONNECTED', + 'UNVERIFIED' => 'UNVERIFIED', + 'BANNED' => 'BANNED', + 'RATE_LIMITED' => 'RATE_LIMITED', + 'PENDING' => 'PENDING', + 'CONNECTED' => 'CONNECTED', + 'UNKNOWN' => 'UNKNOWN', + 'DELETED' => 'DELETED', + 'RESTRICTED' => 'RESTRICTED', + ], + 'example' => 'PENDING', + ], + 'UpQueue' => [ + 'description' => '上行消息队列。', + 'type' => 'string', + 'example' => 'alicom-0939****-queue', + ], + 'NameStatus' => [ + 'description' => '名称审核状态。', + 'type' => 'string', + 'example' => 'Approval', + ], + 'MessagingLimitTier' => [ + 'description' => '号码发送量。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TIER_100K' => '100000', + 'TIER_UNLIMITED' => 'unlimited', + 'TIER_250' => '250', + 'TIER_1K' => '1000', + 'TIER_50' => '50', + 'TIER_10K' => '10000', + ], + 'example' => 'TIER_10K', + ], + 'StatusCallbackUrl' => [ + 'description' => '状态报告通知URL。', + 'type' => 'string', + 'example' => 'https://www.alibaba.com/status', + ], + 'QualityRating' => [ + 'description' => '号码质量。', + 'type' => 'string', + 'enumValueTitles' => [ + 'RED' => 'RED', + 'YELLOW' => 'YELLOW', + 'GREEN' => 'GREEN', + ], + 'example' => 'GREEN', + ], + 'CodeVerificationStatus' => [ + 'description' => '校验状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'REVOKED' => '撤销审核申请', + 'MORE_INFORMATION_REQUESTED' => '需要提供更多信息', + 'VERIFIED' => '校验通过', + 'REJECTED' => '校验被拒绝', + ], + 'example' => 'VERIFIED', + ], + 'NewNameStatus' => [ + 'description' => '新名称审核状态。', + 'type' => 'string', + 'example' => 'Approval', + ], + 'CallingConfigure' => [ + 'type' => 'object', + 'properties' => [ + 'Calling' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'CallHours' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'HolidaySchedule' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'type' => 'string', + 'example' => '2359', + ], + 'StartTime' => [ + 'type' => 'string', + 'example' => '0000', + ], + 'Date' => [ + 'type' => 'string', + 'example' => '2026-01-01', + ], + ], + ], + 'example' => '', + ], + 'TimezoneId' => [ + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'WeeklyOperatingHours' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OpenTime' => [ + 'type' => 'string', + 'example' => '0000', + ], + 'DayOfWeek' => [ + 'type' => 'string', + 'example' => 'MONDAY', + ], + 'CloseTime' => [ + 'type' => 'string', + 'example' => '2359', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'CallbackPermissionStatus' => [ + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'CallIconVisibility' => [ + 'type' => 'string', + 'example' => 'DEFAULT', + ], + ], + 'example' => '', + ], + 'MaxTalkTime' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CallingCallbackUrl' => [ + 'type' => 'string', + 'example' => 'http://aliyun.com', + ], + ], + 'example' => '', + ], + 'PhoneNumber' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'StatusQueue' => [ + 'description' => '状态报告队列。', + 'type' => 'string', + 'example' => 'alicom-0939****-queue', + ], + 'IsOfficial' => [ + 'description' => '是否OBA认证', + 'type' => 'string', + 'example' => 'N', + ], + 'UpCallbackUrl' => [ + 'description' => '上行消息通知URL。', + 'type' => 'string', + 'example' => 'https://www.alibaba.com/inbound'."\n", + ], + ], + ], + 'example' => '', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"PhoneNumbers\\": [\\n {\\n \\"VerifiedName\\": \\"Alibaba\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"UpQueue\\": \\"alicom-0939****-queue\\",\\n \\"NameStatus\\": \\"Approval\\",\\n \\"MessagingLimitTier\\": \\"TIER_10K\\",\\n \\"StatusCallbackUrl\\": \\"https://www.alibaba.com/status\\",\\n \\"QualityRating\\": \\"GREEN\\",\\n \\"CodeVerificationStatus\\": \\"VERIFIED\\",\\n \\"NewNameStatus\\": \\"Approval\\",\\n \\"CallingConfigure\\": {\\n \\"Calling\\": {\\n \\"Status\\": \\"ENABLED\\",\\n \\"CallHours\\": {\\n \\"Status\\": \\"ENABLED\\",\\n \\"HolidaySchedule\\": [\\n {\\n \\"EndTime\\": \\"2359\\",\\n \\"StartTime\\": \\"0000\\",\\n \\"Date\\": \\"2026-01-01\\"\\n }\\n ],\\n \\"TimezoneId\\": \\"Asia/Shanghai\\",\\n \\"WeeklyOperatingHours\\": [\\n {\\n \\"OpenTime\\": \\"0000\\",\\n \\"DayOfWeek\\": \\"MONDAY\\",\\n \\"CloseTime\\": \\"2359\\"\\n }\\n ]\\n },\\n \\"CallbackPermissionStatus\\": \\"示例值示例值示例值\\",\\n \\"CallIconVisibility\\": \\"DEFAULT\\"\\n },\\n \\"MaxTalkTime\\": 100,\\n \\"CallingCallbackUrl\\": \\"http://aliyun.com\\"\\n },\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"StatusQueue\\": \\"alicom-0939****-queue\\",\\n \\"IsOfficial\\": \\"N\\",\\n \\"UpCallbackUrl\\": \\"https://www.alibaba.com/inbound\\\\n\\"\\n }\\n ],\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '同步号码信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'AddChatappPhoneNumber' => [ + 'summary' => '增加号码到Waba中。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '192465', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '93928389****', + ], + ], + [ + 'name' => 'Cc', + 'in' => 'query', + 'schema' => [ + 'description' => '国家区号。', + 'type' => 'string', + 'required' => true, + 'example' => '86', + ], + ], + [ + 'name' => 'PreValidateId', + 'in' => 'query', + 'schema' => [ + 'description' => '预校验号码。'."\n" + .'> 参数已过期', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '1020****', + ], + ], + [ + 'name' => 'VerifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => '号码名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Alibaba', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '增加Whatsapp号码', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetPhoneNumberVerificationStatus' => [ + 'summary' => '获取号码验证状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161957', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86138009****'."\n", + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CodeVerificationStatus' => [ + 'description' => '验证状态。取值：'."\n" + .'- REVOKED：撤销审核申请。'."\n" + .'- MORE_INFORMATION_REQUESTED：需要提供更多信息。'."\n" + .'- VERIFIED：校验通过。'."\n" + .'- REJECTED：校验被拒绝。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'VERIFIED', + ], + 'PhoneNumber' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '861390000****', + ], + 'Id' => [ + 'description' => '号码ID。', + 'type' => 'string', + 'example' => '222434****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\\\n\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2D\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"CodeVerificationStatus\\": \\"VERIFIED\\",\\n \\"PhoneNumber\\": \\"861390000****\\",\\n \\"Id\\": \\"222434****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询号码验证状态', + 'description' => '- 您可调用此接口获取号码验证状态，也可在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看号码验证状态。'."\n" + ."\n" + .'- 在调用此接口前，请确保您WABA下已新增号码，且已提交号码验证。'."\n" + ."\n" + .'- 若您WABA下没有新增的号码，请调用[GetChatappVerifyCode](~~600746~~)、[ChatappVerifyAndRegister](~~600770~~)接口获取验证码校验并注册号码。'."\n" + ."\n" + .'本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetChatappVerifyCode' => [ + 'summary' => '北向接口获取验证码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '161151', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-kei****', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码方式。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'voice' => '通过电话接收', + 'sms' => '通过短信接收', + ], + 'example' => 'sms', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"1612C226-E271-4CFE-9F18-4066D550F91B\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取号码验证码', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappVerifyAndRegister' => [ + 'summary' => '北向接口校验验证码并注册。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161153', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '2938929938****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码。', + 'type' => 'string', + 'required' => true, + 'example' => '1234**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '号码校验并注册', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappPhoneNumberRegister' => [ + 'summary' => '北向接口注册号码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '161154', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '93928389****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '号码注册', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappPhoneNumberDeregister' => [ + 'summary' => '从Waba中取消注册号码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '192466', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码', + 'type' => 'string', + 'required' => true, + 'example' => '86189********', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-sdkj31kj32lk3j', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '取消注册Whatsapp号码', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QueryWabaBusinessInfo' => [ + 'summary' => '获取Waba账号Business平台信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163483', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'waba Id。', + 'type' => 'string', + 'required' => true, + 'example' => '29384882****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'Waba商业信息。', + 'type' => 'object', + 'properties' => [ + 'Vertical' => [ + 'description' => '行业。', + 'type' => 'string', + 'deprecated' => true, + 'example' => '零售', + ], + 'VerificationStatus' => [ + 'description' => '校验状态。', + 'type' => 'string', + 'example' => 'verified', + ], + 'BusinessName' => [ + 'description' => 'Business平台名称。', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'BusinessId' => [ + 'description' => 'Business平台Id。', + 'type' => 'string', + 'example' => '19288282****', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Vertical\\": \\"零售\\",\\n \\"VerificationStatus\\": \\"verified\\",\\n \\"BusinessName\\": \\"Alibaba\\",\\n \\"BusinessId\\": \\"19288282****\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询waba商业信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdatePhoneWebhook' => [ + 'summary' => '修改号码回调地址信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162635', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + [ + 'name' => 'HttpFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用HTTP方式接收回执。取值：'."\n" + ."\n" + .'- Y：是'."\n" + ."\n" + .'- N：否', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'QueueFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用队列方式接收回执。取值：'."\n" + ."\n" + .'- Y：是'."\n" + ."\n" + .'- N：否', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'StatusCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP方式状态报告接口回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'UpCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP方式上行消息接口回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://aliyun.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'null', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '修改号码回调地址信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateAccountWebhook' => [ + 'summary' => '修改账号回调地址信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162636', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '2934839388494****', + ], + ], + [ + 'name' => 'StatusCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP方式通知回调地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'HttpFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用HTTP方式接收回执。取值：'."\n" + .'- Y：是'."\n" + .'- N：否', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'QueueFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否使用队列方式接收回执。取值：'."\n" + .'- Y：是'."\n" + .'- N：否', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"744c4b5c79c9432497a075bdfca3****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '修改账号回调地址信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QueryPhoneBusinessProfile' => [ + 'summary' => '查询号码商业信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '162621', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Vertical' => [ + 'description' => '行业。', + 'type' => 'string', + 'example' => '零售', + ], + 'Description' => [ + 'description' => '描述。', + 'type' => 'string', + 'example' => '描述', + ], + 'Email' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'Address' => [ + 'description' => '地址。', + 'type' => 'string', + 'example' => '长沙', + ], + 'ProfilePictureUrl' => [ + 'description' => '头像。', + 'type' => 'string', + 'example' => 'https://example.img', + ], + 'Websites' => [ + 'description' => '网站。', + 'type' => 'array', + 'items' => [ + 'description' => '网站地址。', + 'type' => 'string', + 'example' => 'https://alibaba.com', + ], + 'example' => '', + ], + 'About' => [ + 'description' => '关于。', + 'type' => 'string', + 'example' => 'business profile', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Vertical\\": \\"零售\\",\\n \\"Description\\": \\"描述\\",\\n \\"Email\\": \\"[email protected]\\",\\n \\"Address\\": \\"长沙\\",\\n \\"ProfilePictureUrl\\": \\"https://example.img\\",\\n \\"Websites\\": [\\n \\"https://alibaba.com\\"\\n ],\\n \\"About\\": \\"business profile\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询号码商业信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ModifyPhoneBusinessProfile' => [ + 'summary' => '修改号码商业信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '162622', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => '地址。', + 'type' => 'string', + 'required' => false, + 'example' => '四川', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Vertical', + 'in' => 'query', + 'schema' => [ + 'description' => '行业。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RETAIL' => '零售', + 'TRAVEL' => '旅游', + 'PROF_SERVICES' => '专业服务', + 'APPAREL' => '服装', + 'GOVT' => '政府', + 'ENTERTAIN' => '娱乐', + 'GROCERY' => '杂货', + 'HOTEL' => '酒店', + 'OTHER' => '其他', + 'AUTO' => '汽车', + 'FINANCE' => '金融', + 'BEAUTY' => '美容', + 'EDU' => '教育', + 'EVENT_PLAN' => '活动策划', + 'NONPROFIT' => '非营利组织', + 'RESTAURANT' => '餐厅', + 'HEALTH' => '健康', + ], + 'example' => 'OTHER', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'ProfilePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '头像URL。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.img', + ], + ], + [ + 'name' => 'Websites', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '网站。', + 'type' => 'array', + 'items' => [ + 'description' => '网站地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'About', + 'in' => 'query', + 'schema' => [ + 'description' => '关于。', + 'type' => 'string', + 'required' => false, + 'example' => 'business profile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改号码商业信息', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateChatappMigrationInitiate' => [ + 'summary' => '新增迁移号码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '162637', + 'abilityTreeNodes' => [ + 'FEATUREcamsGUB2IL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + [ + 'name' => 'MobileNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码，不需要带国家编码。', + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'CountryCode', + 'in' => 'query', + 'schema' => [ + 'description' => '国家编码。', + 'type' => 'string', + 'required' => true, + 'example' => '86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '号码状态。'."\n" + .'取值：MIGRATING：迁移中。', + 'type' => 'string', + 'example' => 'MIGRATING', + ], + 'PhoneNumber' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '861390000****', + ], + 'Id' => [ + 'description' => '号码ID。', + 'type' => 'string', + 'example' => '8282889****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"Status\\": \\"MIGRATING\\",\\n \\"PhoneNumber\\": \\"861390000****\\",\\n \\"Id\\": \\"8282889****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '创建需要迁移号码', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetMigrationVerifyCode' => [ + 'summary' => '获取迁移号码的验证码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164326', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '861380000****', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码方式。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'voice' => '通过电话接收', + 'sms' => '通过短信接收', + ], + 'example' => 'sms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'Id' => [ + 'description' => '号码ID。', + 'type' => 'string', + 'example' => '8282889****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"Id\\": \\"8282889****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取迁移号码的验证码', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappMigrationVerified' => [ + 'summary' => '迁移号码校验。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164328', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '86138000****', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => [ + 'description' => '验证码。', + 'type' => 'string', + 'required' => true, + 'example' => '8287**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'Id' => [ + 'description' => '号码ID。', + 'type' => 'string', + 'example' => '8282889****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"Id\\": \\"8282889****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '迁移号码校验', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ChatappMigrationRegister' => [ + 'summary' => '迁移号码注册。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164337', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '8613800****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '迁移号码注册', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetChatappUploadAuthorization' => [ + 'summary' => '获取上传文件的鉴权信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '169912', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SecurityToken' => [ + 'description' => '授权密钥。', + 'type' => 'string', + 'example' => 'dkdieiii****', + ], + 'Expire' => [ + 'description' => '超时时间。单位为秒。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'BucketName' => [ + 'description' => 'Oss上传的Bucket名称。', + 'type' => 'string', + 'example' => 'oss', + ], + 'AccessKeyId' => [ + 'description' => 'Oss授权上传文件的AccessKeyId。', + 'type' => 'string', + 'example' => '2skeuurfj****', + ], + 'AccessKeySecret' => [ + 'description' => 'Oss授权上传文件的Secret。', + 'type' => 'string', + 'example' => 'skdkdukeuuuu****', + ], + 'EndPoint' => [ + 'description' => 'Oss授权上传的服务器地址。', + 'type' => 'string', + 'example' => 'https://oss.com', + ], + 'Dir' => [ + 'description' => 'Oss授权上传的目录。', + 'type' => 'string', + 'example' => '100010****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"SecurityToken\\": \\"dkdieiii****\\",\\n \\"Expire\\": 3600,\\n \\"BucketName\\": \\"oss\\",\\n \\"AccessKeyId\\": \\"2skeuurfj****\\",\\n \\"AccessKeySecret\\": \\"skdkdukeuuuu****\\",\\n \\"EndPoint\\": \\"https://oss.com\\",\\n \\"Dir\\": \\"100010****\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取上传文件的鉴权信息', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetCommerceSetting' => [ + 'summary' => '获取号码商业设置状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'CartEnable' => [ + 'description' => '是否启用购物车。'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：不启用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CatalogVisible' => [ + 'description' => '是否显示目录。'."\n" + .'- true：显示'."\n" + .'- false：不显示', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": {\\n \\"CartEnable\\": false,\\n \\"CatalogVisible\\": false\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取号码商业设置状态', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateCommerceSetting' => [ + 'summary' => '修改号码商业设置状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + ], + ], + [ + 'name' => 'CartEnable', + 'in' => 'query', + 'schema' => [ + 'description' => '是否启用购物车。取值：'."\n" + ."\n" + .'- true：启用'."\n" + ."\n" + .'- false：不启用', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'CatalogVisible', + 'in' => 'query', + 'schema' => [ + 'description' => '是否显示目录。取值：'."\n" + .'- true：显示'."\n" + .'- false：不显示', + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改号码商业设置状态', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetWhatsappHealthStatus' => [ + 'summary' => '获取不同类型的节点发送消息的健康状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228872', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '节点类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'template' => '模板', + 'phone' => '电话号码', + 'waba' => 'waba账号ID', + ], + 'example' => 'waba', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '399299***', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '模板语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WabaId。', + 'type' => 'string', + 'required' => false, + 'example' => '299399****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2993****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CanSendMessage' => [ + 'description' => '是否能发送消息。', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'Entities' => [ + 'description' => '查询到的实体数据。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的实体数据。', + 'type' => 'object', + 'properties' => [ + 'EntityType' => [ + 'description' => '实体类型。', + 'type' => 'string', + 'example' => 'PHONE_NUMBER', + ], + 'TemplateCode' => [ + 'description' => '模板Code。NodeType为**template**时此字段必填。', + 'type' => 'string', + 'example' => '939928****', + ], + 'Errors' => [ + 'description' => '错误列表。', + 'type' => 'array', + 'items' => [ + 'description' => '错误信息。', + 'type' => 'object', + 'properties' => [ + 'ErrorDescription' => [ + 'description' => '错误描述。', + 'type' => 'string', + 'example' => 'There is an error with the payment method.', + ], + 'PossibleSolution' => [ + 'description' => '可能的解决方案。', + 'type' => 'string', + 'example' => 'There was an error with your payment method. Please add a new payment method to the account.', + ], + 'ErrorCode' => [ + 'description' => '错误码。', + 'type' => 'string', + 'example' => '141006', + ], + ], + ], + 'example' => '', + ], + 'Language' => [ + 'description' => '模板语言。', + 'type' => 'string', + 'example' => 'en', + ], + 'CanSendMessage' => [ + 'description' => '是否能发送消息。', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'PhoneNumber' => [ + 'description' => '发送号码。', + 'type' => 'string', + 'example' => '86138****', + ], + 'WabaId' => [ + 'description' => 'WABA账号ID。可在[Chat App消息服务控制台](https://cams.console.aliyun.com/)WABA注册完成后查看WabaId。', + 'type' => 'string', + 'example' => '39939***', + ], + 'BusinessId' => [ + 'description' => 'Business平台Id。', + 'type' => 'string', + 'example' => '3992****', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"DAC72B08-3327-33EF-BEDC-8EC3E83A6575\\",\\n \\"Data\\": {\\n \\"CanSendMessage\\": \\"AVAILABLE\\",\\n \\"Entities\\": [\\n {\\n \\"EntityType\\": \\"PHONE_NUMBER\\",\\n \\"TemplateCode\\": \\"939928****\\",\\n \\"Errors\\": [\\n {\\n \\"ErrorDescription\\": \\"There is an error with the payment method.\\",\\n \\"PossibleSolution\\": \\"There was an error with your payment method. Please add a new payment method to the account.\\",\\n \\"ErrorCode\\": \\"141006\\"\\n }\\n ],\\n \\"Language\\": \\"en\\",\\n \\"CanSendMessage\\": \\"AVAILABLE\\",\\n \\"PhoneNumber\\": \\"86138****\\",\\n \\"WabaId\\": \\"39939***\\",\\n \\"BusinessId\\": \\"3992****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取Whatsapp消息发送健康状态', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'此接口会直接拉取facebook的数据，facebook接口调用总量有限制，请合理使用。', + ], + 'UpdateConversationalAutomation' => [ + 'summary' => '修改号码欢迎消息、开场白和命令。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228873', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EnableWelcomeMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '是否开启欢迎消息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '86130000***', + ], + ], + [ + 'name' => 'Commands', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '命令列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命令对象。', + 'type' => 'object', + 'properties' => [ + 'CommandDescription' => [ + 'description' => '命令描述。', + 'type' => 'string', + 'required' => false, + 'example' => '命令1', + ], + 'CommandName' => [ + 'description' => '指令名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Prompts', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '开场白列表。', + 'type' => 'array', + 'items' => [ + 'description' => '开场白信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'prompt1', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2993****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改号码欢迎消息、开场白和命令', + 'description' => '### QPS限制 '."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'此接口会直接拉取facebook的数据，facebook接口调用总量有限制，请合理使用。', + ], + 'GetConversationalAutomation' => [ + 'summary' => '获取欢迎消息、开场白和命令。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '228871', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户的实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-3ie***', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '86130000***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'Prompts' => [ + 'description' => '开场白列表。', + 'type' => 'array', + 'items' => [ + 'description' => '开场白信息。', + 'type' => 'string', + 'example' => 'prompt1', + ], + 'example' => '', + ], + 'Commands' => [ + 'description' => '命令列表。', + 'type' => 'array', + 'items' => [ + 'description' => '命令对象。', + 'type' => 'object', + 'properties' => [ + 'CommandDescription' => [ + 'description' => '命令描述。', + 'type' => 'string', + 'example' => 'description', + ], + 'CommandName' => [ + 'description' => '命令名称。', + 'type' => 'string', + 'example' => 'common1', + ], + ], + ], + 'example' => '', + ], + 'PhoneNumber' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'EnableWelcomeMessage' => [ + 'description' => '是否开启欢迎消息。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Prompts\\": [\\n \\"prompt1\\"\\n ],\\n \\"Commands\\": [\\n {\\n \\"CommandDescription\\": \\"description\\",\\n \\"CommandName\\": \\"common1\\"\\n }\\n ],\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"EnableWelcomeMessage\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取号码欢迎消息、开场白和命令', + 'description' => '### QPS限制 '."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'此接口会直接拉取facebook的数据，facebook接口调用总量有限制，请合理使用。', + ], + 'GetPhoneEncryptionPublicKey' => [ + 'summary' => '获取号码的加密公钥。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201018', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86189********', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'EncryptionPublicKey' => [ + 'description' => '公钥。', + 'type' => 'string', + 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\/swzTMEopLORQV28uqN\\/2\\/x9hjU\\****\\/Zwa\\/Vk5Svp4\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\nkwIDAQAB\\n-----END PUBLIC KEY-----"', + ], + 'PhoneNumber' => [ + 'description' => '电话号码。', + 'type' => 'string', + 'example' => '861526377****', + ], + 'EncryptionPublicKeyStatus' => [ + 'description' => '公钥有效状态，取值：'."\n" + ."\n" + .'- MISMATCH：无效。'."\n" + ."\n" + .'- VALID：有效。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'VALID', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"DAC72B08-3327-33EF-BEDC-8EC3E83A6575\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"EncryptionPublicKey\\": \\"-----BEGIN PUBLIC KEY-----\\\\\\\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\\\\\\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\\\\\\\/swzTMEopLORQV28uqN\\\\\\\\/2\\\\\\\\/x9hjU\\\\\\\\****\\\\\\\\/Zwa\\\\\\\\/Vk5Svp4\\\\\\\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\\\\\\\nkwIDAQAB\\\\\\\\n-----END PUBLIC KEY-----\\\\\\"\\",\\n \\"PhoneNumber\\": \\"861526377****\\",\\n \\"EncryptionPublicKeyStatus\\": \\"VALID\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取号码的加密公钥', + 'description' => '- 在调用此接口前，请确保您WABA下已新增号码，且已通过号码验证。'."\n" + ."\n" + .'- 若您WABA下没有新增的号码，请调用[GetChatappVerifyCode](~~600746~~)、[ChatappVerifyAndRegister](~~600770~~)接口获取验证码校验并注册号码。'."\n" + ."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdatePhoneEncryptionPublicKey' => [ + 'summary' => '更新号码的加密公钥。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201015', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86158********', + ], + ], + [ + 'name' => 'EncryptionPublicKey', + 'in' => 'query', + 'schema' => [ + 'description' => '公钥。', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\/swzTMEopLORQV28uqN\\/2\\/x9hjU\\****\\/Zwa\\/Vk5Svp4\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\nkwIDAQAB\\n-----END PUBLIC KEY-----"', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '更新号码的加密公钥', + 'description' => '- 在调用此接口前，请确保您WABA下已新增号码，且已通过号码验证。'."\n" + .'- 若您WABA下没有新增的号码，请调用[GetChatappVerifyCode](~~600746~~)、[ChatappVerifyAndRegister](~~600770~~)接口获取验证码校验并注册号码。'."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdatePhoneMessageQrdl' => [ + 'summary' => '修改消息二维码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200919', + 'abilityTreeNodes' => [ + 'FEATUREcamsU2M7I2', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86158********', + ], + ], + [ + 'name' => 'GenerateQrImage', + 'in' => 'query', + 'schema' => [ + 'description' => '生成图片类型。类型取值：'."\n" + ."\n" + .'- PNG'."\n" + ."\n" + .' - SVG', + 'type' => 'string', + 'required' => true, + 'example' => 'SVG', + ], + ], + [ + 'name' => 'PrefilledMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'QrdlCode', + 'in' => 'query', + 'schema' => [ + 'description' => '二维码编码。您在调用[CreatePhoneMessageQrdl](~~2638749~~)接口时返回的QrdlCode。', + 'type' => 'string', + 'required' => true, + 'example' => 'D9II3***', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D******', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'description' => '二维码地址。', + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'PhoneNumber' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '86158********', + ], + 'QrdlCode' => [ + 'description' => '二维码编码。', + 'type' => 'string', + 'example' => 'D9AA3***'."\n", + ], + 'DeepLinkUrl' => [ + 'description' => '深度链接地址。', + 'type' => 'string', + 'example' => 'https://wa.msg/', + ], + 'GenerateQrImage' => [ + 'description' => '生成图片类型。', + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'example' => 'Hello', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"1612C226-E271-4CFE-9F18-4066D******\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"QrImageUrl\\": \\"https://img.png\\",\\n \\"PhoneNumber\\": \\"86158********\\",\\n \\"QrdlCode\\": \\"D9AA3***\\\\n\\",\\n \\"DeepLinkUrl\\": \\"https://wa.msg/\\",\\n \\"GenerateQrImage\\": \\"PNG\\",\\n \\"PrefilledMessage\\": \\"Hello\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '修改消息二维码', + 'description' => '- 修改消息二维码后，用户通过扫描原二维码将无法打开对应的商家号码，请谨慎操作。'."\n" + ."\n" + .'- 您在调用此接口前，请确保您已成功创建消息二维码。'."\n" + ."\n" + .'- 若您没有成功创建消息二维码，请先通过[CreatePhoneMessageQrdl](~~2638749~~)接口创建消息二维码。'."\n" + ."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListPhoneMessageQrdl' => [ + 'summary' => '查询消息二维码列表数据。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200921', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码', + 'type' => 'string', + 'required' => true, + 'example' => '86163********', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-8filvjc8snw', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对像。', + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'description' => '二维码地址。', + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'PhoneNumber' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '86138009****', + ], + 'QrdlCode' => [ + 'description' => '二维码编码。', + 'type' => 'string', + 'example' => 'IUIED999', + ], + 'DeepLinkUrl' => [ + 'description' => '深度链接地址。', + 'type' => 'string', + 'example' => 'https://wa.msg/', + ], + 'GenerateQrImage' => [ + 'description' => '生成图片类型。', + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'example' => 'Hello', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '结果返回OK为正常。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": [\\n {\\n \\"QrImageUrl\\": \\"https://img.png\\",\\n \\"PhoneNumber\\": \\"86138009****\\",\\n \\"QrdlCode\\": \\"IUIED999\\",\\n \\"DeepLinkUrl\\": \\"https://wa.msg/\\",\\n \\"GenerateQrImage\\": \\"PNG\\",\\n \\"PrefilledMessage\\": \\"Hello\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询消息二维码列表', + 'description' => '本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeletePhoneMessageQrdl' => [ + 'summary' => '删除消息二维码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '200942', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86158********'."\n", + ], + ], + [ + 'name' => 'QrdlCode', + 'in' => 'query', + 'schema' => [ + 'description' => '二维码编码。您在创建消息二维码时调用[CreatePhoneMessageQrdl](~~2638749~~)接口时返回的QrdlCode，或在修改二维码时调用[UpdatePhoneMessageQrdl](~~2638746~~)接口返回的QrdlCode。', + 'type' => 'string', + 'required' => true, + 'example' => 'D9II3***'."\n", + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回参数。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '删除消息二维码', + 'description' => '- 在删除消息二维码后，用户将无法通过扫描原二维码打开对应的商家号码，请谨慎操作。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有成功创建的消息二维码。'."\n" + ."\n" + .'- 若您没有成功创建的消息二维码，请先调用[CreatePhoneMessageQrdl](~~2638749~~)接口创建消息二维码。'."\n" + ."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreatePhoneMessageQrdl' => [ + 'summary' => '创建消息二维码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '200908', + 'abilityTreeNodes' => [ + 'FEATUREcamsU2M7I2', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码。在'."\n" + .'<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '86138009****'."\n", + ], + ], + [ + 'name' => 'GenerateQrImage', + 'in' => 'query', + 'schema' => [ + 'description' => '生成图片类型。类型取值：'."\n" + ."\n" + .'- PNG'."\n" + ."\n" + .' - SVG', + 'type' => 'string', + 'required' => true, + 'example' => 'PNG', + ], + ], + [ + 'name' => 'PrefilledMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'required' => true, + 'example' => 'test', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面查看Space ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-kei****'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'description' => '二维码地址。', + 'type' => 'string', + 'example' => 'http://img.png', + ], + 'PhoneNumber' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '86138009****', + ], + 'QrdlCode' => [ + 'description' => '二维码编码。', + 'type' => 'string', + 'example' => 'D9II3***', + ], + 'DeepLinkUrl' => [ + 'description' => '深度链接地址。', + 'type' => 'string', + 'example' => 'https://wa.qrdl/', + ], + 'GenerateQrImage' => [ + 'description' => '生成图片类型。', + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'example' => 'Hello', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"QrImageUrl\\": \\"http://img.png\\",\\n \\"PhoneNumber\\": \\"86138009****\\",\\n \\"QrdlCode\\": \\"D9II3***\\",\\n \\"DeepLinkUrl\\": \\"https://wa.qrdl/\\",\\n \\"GenerateQrImage\\": \\"PNG\\",\\n \\"PrefilledMessage\\": \\"Hello\\"\\n },\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '创建消息二维码', + 'description' => '- 创建完成二维码后，用户可使用WhatsApp扫描二维码快速打开对应的商家号码。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的WhatsApp消息通道。'."\n" + ."\n" + .'- 若您没有已成功创建的WhatsApp消息通道，可在'."\n" + .'<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props>'."\n" + .'<props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>'."\n" + .'界面手动创建WhatsApp消息通道。'."\n" + .'#### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QueryChatappPhoneNumbers' => [ + 'summary' => '查询客户下的所有发送号码及号码状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '159850', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Isv校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'aksik93kdkkxmwol9****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '号码状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'VERIFIED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PhoneNumbers' => [ + 'description' => '号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '结构体。', + 'type' => 'object', + 'properties' => [ + 'VerifiedName' => [ + 'description' => '申请名称。', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Status' => [ + 'description' => '号码状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'MIGRATED' => '已迁移', + 'FLAGGED' => '被标记', + 'DISCONNECTED' => '已断开', + 'UNVERIFIED' => '未验证', + 'BANNED' => '已封禁', + 'RATE_LIMITED' => '限制发送', + 'PENDING' => '待定', + 'CONNECTED' => '已连接', + 'UNKNOWN' => '未知', + 'DELETED' => '已删除', + 'RESTRICTED' => '已受限', + ], + 'example' => 'CONNECTED', + ], + 'UpQueue' => [ + 'description' => '上行消息通知Queue。', + 'type' => 'string', + 'example' => 'Alicom-Queue-****-ChatAppInbound', + ], + 'NameStatus' => [ + 'description' => '名称状态。', + 'type' => 'string', + 'example' => 'Approval', + ], + 'MessagingLimitTier' => [ + 'description' => '号码发送量。', + 'type' => 'string', + 'enumValueTitles' => [ + 'TIER_100K' => '100000', + 'TIER_UNLIMITED' => 'unlimited', + 'TIER_250' => '250', + 'TIER_1K' => '1000', + 'TIER_50' => '50', + 'TIER_10K' => '10000', + ], + 'example' => 'TIER_10K', + ], + 'StatusCallbackUrl' => [ + 'description' => '状态报告通知URL。', + 'type' => 'string', + 'example' => 'https://ali.com/status', + ], + 'QualityRating' => [ + 'description' => '号码质量。', + 'type' => 'string', + 'enumValueTitles' => [ + 'RED' => '低质量', + 'YELLOW' => '中质量', + 'UNKNOWN' => '未知', + 'GREEN' => '高质量', + ], + 'example' => 'GREEN', + ], + 'CodeVerificationStatus' => [ + 'description' => '号码校验状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'REVOKED' => '已撤销', + 'MORE_INFORMATION_REQUESTED' => '需要提供更多信息', + 'VERIFIED' => '校验通过', + 'REJECTED' => '校验被拒绝', + ], + 'example' => 'VERIFIED', + ], + 'NewNameStatus' => [ + 'description' => '新名称审核状态。', + 'type' => 'string', + 'example' => 'Approval', + ], + 'CallingConfigure' => [ + 'type' => 'object', + 'properties' => [ + 'Calling' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'CallHours' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'CallbackPermissionStatus' => [ + 'type' => 'string', + 'example' => 'ENABLED', + ], + 'HolidaySchedule' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'type' => 'string', + 'example' => '2359', + ], + 'StartTime' => [ + 'type' => 'string', + 'example' => '0000', + ], + 'Date' => [ + 'type' => 'string', + 'example' => '2026-01-01', + ], + ], + ], + 'example' => '', + ], + 'CallIconVisibility' => [ + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'TimezoneId' => [ + 'type' => 'string', + 'example' => 'Asia/Shanghai', + ], + 'WeeklyOperatingHours' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OpenTime' => [ + 'type' => 'string', + 'example' => '0000', + ], + 'DayOfWeek' => [ + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'CloseTime' => [ + 'type' => 'string', + 'example' => '2359', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'MaxTalkTime' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'CallingCallbackUrl' => [ + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + ], + 'example' => '', + ], + 'PhoneNumber' => [ + 'description' => '号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'StatusQueue' => [ + 'description' => '状态报告通知Queue。', + 'type' => 'string', + 'example' => 'Alicom-Queue-****-ChatAppStatus', + ], + 'IsOfficial' => [ + 'description' => '是否认证', + 'type' => 'string', + 'example' => 'N', + ], + 'UpCallbackUrl' => [ + 'description' => '上行消息通知URL。', + 'type' => 'string', + 'example' => 'https://ali.com/inbound', + ], + ], + ], + 'example' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '信息。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PhoneNumbers\\": [\\n {\\n \\"VerifiedName\\": \\"Alibaba\\",\\n \\"Status\\": \\"CONNECTED\\",\\n \\"UpQueue\\": \\"Alicom-Queue-****-ChatAppInbound\\",\\n \\"NameStatus\\": \\"Approval\\",\\n \\"MessagingLimitTier\\": \\"TIER_10K\\",\\n \\"StatusCallbackUrl\\": \\"https://ali.com/status\\",\\n \\"QualityRating\\": \\"GREEN\\",\\n \\"CodeVerificationStatus\\": \\"VERIFIED\\",\\n \\"NewNameStatus\\": \\"Approval\\",\\n \\"CallingConfigure\\": {\\n \\"Calling\\": {\\n \\"Status\\": \\"ENABLED\\",\\n \\"CallHours\\": {\\n \\"Status\\": \\"ENABLED\\",\\n \\"CallbackPermissionStatus\\": \\"ENABLED\\",\\n \\"HolidaySchedule\\": [\\n {\\n \\"EndTime\\": \\"2359\\",\\n \\"StartTime\\": \\"0000\\",\\n \\"Date\\": \\"2026-01-01\\"\\n }\\n ],\\n \\"CallIconVisibility\\": \\"DEFAULT\\",\\n \\"TimezoneId\\": \\"Asia/Shanghai\\",\\n \\"WeeklyOperatingHours\\": [\\n {\\n \\"OpenTime\\": \\"0000\\",\\n \\"DayOfWeek\\": \\"示例值示例值示例值\\",\\n \\"CloseTime\\": \\"2359\\"\\n }\\n ]\\n }\\n },\\n \\"MaxTalkTime\\": 1000,\\n \\"CallingCallbackUrl\\": \\"https://aliyun.com\\"\\n },\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"StatusQueue\\": \\"Alicom-Queue-****-ChatAppStatus\\",\\n \\"IsOfficial\\": \\"N\\",\\n \\"UpCallbackUrl\\": \\"https://ali.com/inbound\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": \\"示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询客户下的所有发送号码及号码状态', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QueryChatappBindWaba' => [ + 'summary' => '查询客户绑定的WABA。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '159851', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'aksik93kdkkxmwol93939', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回对象', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'AuthInternationalRateEligibility' => [ + 'description' => 'WABA相关信息。', + 'type' => 'object', + 'example' => '', + ], + 'MarketingMessageLiteStatus' => [ + 'description' => 'MML状态', + 'type' => 'string', + 'example' => 'Y', + ], + 'BusinessName' => [ + 'description' => 'Business平台名称。', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Currency' => [ + 'description' => '币种。', + 'type' => 'string', + 'example' => 'USD', + ], + 'Id' => [ + 'description' => 'WABA账户ID。', + 'type' => 'string', + 'example' => '20393988393993***', + ], + 'AccountReviewStatus' => [ + 'description' => 'Waba审核状态。取值：'."\n" + .' - PENDING ：待审核'."\n" + .' - APPROVED ：审核通过'."\n" + .' - REJECTED ：审核不通过'."\n" + .' - DISABLED：禁用', + 'type' => 'string', + 'example' => 'APPROVED', + ], + 'MessageTemplateNamespace' => [ + 'description' => '模板命名空间。', + 'type' => 'string', + 'example' => '93e6b26e_8a67_4163_a093_ebfe645a66b0', + ], + 'BusinessId' => [ + 'description' => 'Business平台Id。', + 'type' => 'string', + 'example' => '19293988***', + ], + 'Name' => [ + 'description' => 'WABA账号名称。', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'PrimaryBusinessLocation' => [ + 'description' => '国际费率能力资格。', + 'type' => 'string', + 'example' => '"start_time":1721952000', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": {\\n \\"AuthInternationalRateEligibility\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"MarketingMessageLiteStatus\\": \\"Y\\",\\n \\"BusinessName\\": \\"Alibaba\\",\\n \\"Currency\\": \\"USD\\",\\n \\"Id\\": \\"20393988393993***\\",\\n \\"AccountReviewStatus\\": \\"APPROVED\\",\\n \\"MessageTemplateNamespace\\": \\"93e6b26e_8a67_4163_a093_ebfe645a66b0\\",\\n \\"BusinessId\\": \\"19293988***\\",\\n \\"Name\\": \\"Alibaba\\",\\n \\"PrimaryBusinessLocation\\": \\"\\\\\\"start_time\\\\\\":1721952000\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询客户绑定的Waba', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SendChatappMassMessage' => [ + 'summary' => '批量发送ChatApp消息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '149595', + 'abilityTreeNodes' => [ + 'FEATUREcamsU2M7I2', + ], + ], + 'parameters' => [ + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值：'."\n" + ."\n" + .'- **whatsapp**。'."\n" + ."\n" + .'- **messenger**。'."\n" + .'- **instagram**。'."\n" + ."\n" + .'<props="intl">- **viber**。</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'whatsapp', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**模板设计**界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => '1119***************', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。详细语言代码列表，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '发送方号码。'."\n" + ."\n" + .'- 当ChannelType为**whatsapp**时为注册并绑定WhatsApp的电话号码。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。'."\n" + .'- 当ChannelType为**messenger**时为公共主页ID（Page ID）。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**公共主页**界面查看。'."\n" + .'- 当ChannelType为**instagram**时为instagram专业账户ID（Account ID）。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**专业账户**界面查看。'."\n" + .'<props="intl">- 当ChannelType为**viber**时为Viber服务号ID（Service ID）。在[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)>**管理**>**服务号管理**界面查看。</props>', + 'type' => 'string', + 'required' => true, + 'example' => '861387777****', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV客户wabaId。 过时的参数，请使用CustSpaceId，直客客户实例ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>界面查看。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cams-8c8*********'."\n", + ], + ], + [ + 'name' => 'FallBackId', + 'in' => 'query', + 'schema' => [ + 'description' => '回落策略ID。该参数为国际站配置参数，中国站可忽略此参数。<props="intl">在[**回落策略**](https://chatapp.console.alibabacloud.com/FallbackStrategy)界面查看策略ID。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'S0****', + ], + ], + [ + 'name' => 'FallBackContent', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义回落内容。该参数为国际站配置参数，中国站可忽略此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Fallback SMS', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10000****', + ], + ], + [ + 'name' => 'SenderList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '接收方号码列表。', + 'type' => 'array', + 'items' => [ + 'description' => '接收方号码。', + 'type' => 'object', + 'properties' => [ + 'TemplateParams' => [ + 'description' => '模板参数集合。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + 'example' => '', + ], + 'FlowAction' => [ + 'description' => 'Flow消息对象。', + 'type' => 'object', + 'properties' => [ + 'FlowActionData' => [ + 'description' => 'flow默认参数集合。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => '', + ], + 'FlowToken' => [ + 'description' => '自定义flow token信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'kde****', + ], + ], + 'required' => false, + 'example' => '', + ], + 'Payload' => [ + 'description' => '按钮的触发消息标识列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按钮的触发消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'payloadtext', + ], + 'required' => false, + 'example' => '', + ], + 'To' => [ + 'description' => '接收方号码。'."\n" + ."\n" + .'- 当ChannelType为**whatapp**时为消息接收方的电话号码。'."\n" + .'- 当ChannelType为**messenger**为与Facebook页面消息互动时生成的一个Page-Scoped User ID。'."\n" + .'- 当ChannelType为**instagram**时为用户与Instagram商业账号或创作者账号消息互动时生成的Instagram User ID。'."\n" + .'<props="intl">- 当ChannelType为**viber**时为消息接收方的电话号码。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '861386666****'."\n", + ], + 'ProductAction' => [ + 'description' => '商品信息，此参数只针对于whatsapp类型通道。即为您在Meta上上传的商品信息。', + 'type' => 'object', + 'properties' => [ + 'ThumbnailProductRetailerId' => [ + 'description' => '商品目录ID。可通过[ListProductCatalog](~~2539783~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'skkks99****', + ], + 'Sections' => [ + 'description' => '商品分类列表（最多可以有10个分类，30个商品）。', + 'type' => 'array', + 'items' => [ + 'description' => '商品分类。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '分类名称。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**目录管理**>**商品管理**界面查看或通过[ListProduct](~~2557786~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + 'ProductItems' => [ + 'description' => '商品信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '商品信息。', + 'type' => 'object', + 'properties' => [ + 'ProductRetailerId' => [ + 'description' => '商品ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**目录管理**>**商品管理**界面查看或通过[ListProduct](~~2557786~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ksi3****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权，已弃用，可忽略此参数。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'skdi3kksloslikd****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId ，直客客户实例ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-8c8*********', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Viber消息发送超时时间。此参数为国际站参数，中国站可忽略此参数。<props="intl">单位：秒，取值范围 30~1209600。</props>', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '46', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'description' => 'Viber消息类型，此参数为国际站参数，中国站可忽略此参数。'."\n" + .'<props="intl">取值：</props>'."\n" + .'<props="intl">- **pormotion**：营销、促销类消息。</props>'."\n" + .'<props="intl">- **transaction**：通知类消息。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'promotion', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '标签信息，Viber消息发送时自定义标签信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'Tag'."\n", + ], + ], + [ + 'name' => 'FallBackDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '回落触发时间。此参数为国际站参数，中国站可忽略此参数。<props="intl">消息在指定时间内没有返回已到达回执消息时进行回落, 不填代表不根据此时间判断回落，只有发送失败和有失败的状态报告时才会回落。单位：秒。最小值：60，最大值：43200。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + ], + [ + 'name' => 'FallBackRule', + 'in' => 'query', + 'schema' => [ + 'description' => '回落规则。此参数为国际站参数，中国站可忽略此参数。'."\n" + .'</props><props="intl">取值：</props>'."\n" + .'<props="intl">- **undelivered**：消息不能发送到端时进行回落（在发送状态时模板、参数需要校验通过，模板被封、号码被封等不做校验）。参数值为空时默认使用此规则。</props>'."\n" + .'<props="intl">- **sentFailed**：消息在校验模板、模板变量等参数时，校验不通过也会进行回落。只会强校验channelType, type, messageType, to, from(是否存在) 几个参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'undelivered', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**模板设计**界面查看模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'GroupMessageId' => [ + 'description' => '批量消息ID。', + 'type' => 'string', + 'example' => '890000010002****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"GroupMessageId\\": \\"890000010002****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '批量发送ChatApp消息', + 'description' => '- 您可调用此接口批量发送消息，也可在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**消息发送**界面手动批量发送消息。'."\n" + ."\n" + .'- 在调用此接口前。请确保您已成功创建通道，且已有审核通过的模板。'."\n" + ."\n" + .'- WhatsApp通道类型需已完成[WABA注册及绑定](~~172335~~)、[新增号码](~~2656131~~)。'."\n" + .'- Messenger通道类型需已完成[连接公共主页账号](~~2837713~~)。'."\n" + .'- Instagram通道类型需已完成[连接专业账户账号](~~2837720~~)。'."\n" + ."\n" + .'<props="intl">- Viber通道类型需已完成[申请服务号](~~2807995~~)。</props>'."\n" + ."\n" + .'### QPS限制'."\n" + .'- 本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'- 单次请求支持最多1,000个号码。'."\n" + ."\n" + .'### 状态变更'."\n" + .'消息发送状态可以通过MNS/HTTP方式监听，具体请参考[回执消息](~~421545~~)。', + ], + 'SendChatappMessage' => [ + 'summary' => '发送ChatApp消息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '130289', + 'abilityTreeNodes' => [ + 'FEATUREcamsU2M7I2', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值： '."\n" + ."\n" + .'- **whatsapp**。 '."\n" + ."\n" + .'- **messenger**。 '."\n" + ."\n" + .'- **instagram**。'."\n" + ."\n" + .'<props="intl">- **viber**。 </props>', + 'type' => 'string', + 'required' => true, + 'example' => 'whatsapp', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '消息类型。取值：'."\n" + ."\n" + .'- template：在控制台已被审核通过的消息模板，可以在任意时间发送。'."\n" + ."\n" + .'- message：任意格式的消息，时间限制为在收到用户最后一条消息后的24小时内可发送此类消息。'."\n" + ."\n" + .'><notice>当Type为template时，必须设置TemplateCode；当Type为message时，必须设置MessageType。></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'message', + ], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => [ + 'description' => '当Type为message时，指定消息的详细类型。取值：'."\n" + ."\n" + .'- text：纯文本消息，设置此类型时Content字段中的Text参数为必填。'."\n" + ."\n" + .'- image：图片消息，设置此类型时Content字段中的Link参数为必填，Caption参数为选填。'."\n" + ."\n" + .'- video：视频消息，设置此类型时Content字段中的Link参数为必填，Caption参数为选填。'."\n" + ."\n" + .'- audio：音频消息，设置此类型时Content字段中的Link参数为必填，Caption参数则无效。'."\n" + ."\n" + .'- document：文档消息，设置此类型时Content字段中的Link参数及FileName参数为必填，Caption参数则无效。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**模板设计**界面查看模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '1119***************'."\n", + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。详细语言代码列表，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '发送方号码。'."\n" + ."\n" + .'- 当ChannelType为**whatsapp**时为注册并绑定WhatsApp的电话号码。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。'."\n" + .'- 当ChannelType为**messenger**时为公共主页ID（Page ID）。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**公共主页**界面查看。'."\n" + .'- 当ChannelType为**instagram**时为instagram专业账户ID（Account ID）。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**专业账户**界面查看。'."\n" + .'<props="intl">- 当ChannelType为**viber**时为Viber服务号ID（Service ID）。在[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)>**管理**>**服务号管理**界面查看。</props>', + 'type' => 'string', + 'required' => true, + 'example' => '861387777****', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '接收方号码。'."\n" + ."\n" + .'- 当ChannelType为**whatapp**时为消息接收方的电话号码。'."\n" + .'- 当ChannelType为**messenger**为与Facebook页面消息互动时生成的一个Page-Scoped User ID。'."\n" + .'- 当ChannelType为**instagram**时为用户与Instagram商业账号或创作者账号消息互动时生成的Instagram User ID。'."\n" + .'<props="intl">- 当ChannelType为**viber**时为消息接收方的电话号码。</props>', + 'type' => 'string', + 'required' => true, + 'example' => '861388988****', + ], + ], + [ + 'name' => 'TemplateParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '模板参数集合。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + 'example' => '', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'description' => '消息内容。'."\n" + ."\n" + .'**WhatsApp消息备注：**'."\n" + .'- 当**messageType**为**text**时，**text**字段为必填，**Caption**禁止填写。'."\n" + .'- 当**messageType**为**image**时，**Link**必填。'."\n" + .'- 当**messageType**为**video**时，**Link**必填。'."\n" + .'- 当**messageType**为**audio**时，**Link**必填，**Caption**字段无效。'."\n" + .'- 当**messageType**为**document**时，**Link**和**FileName**字段必填，**Caption**字段无效。'."\n" + .'- 当**messageType**为**interactive**时，**type**和**action**字段必填。'."\n" + .'- 当**messageType**为**contacts**时，**name**字段必填。'."\n" + .'- 当**messageType**为**location**时，**longitude**和**latitude**字段必填。'."\n" + .'- 当**messageType**为**sticker**时，**Link**字段必填，**Caption**和**FileName**字段无效。'."\n" + .'- 当**messageType**为**reaction**时，**messageId**和**emoji**字段必填。'."\n" + ."\n\n" + .'**Messenger消息备注：**'."\n" + .'- 当**messageType**为**text**时，**text**字段必填。'."\n" + .'- 当**messageType**为**image**、**video**、**audio**、**document**时，**link**字段必填。'."\n" + ."\n" + .'**Instagram消息备注：**'."\n" + .'- 当**messageType**为**text**时，**text**字段必填。'."\n" + .'- 当**messageType**为**image**、**video**、**audio**时，**link**字段必填。'."\n" + ."\n\n" + .'<props="intl">**Viber消息备注：**</props>'."\n" + .'<props="intl">- 当**messageType**为**text**时，**text**字段必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**image**时，**link**字段必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**video**时，**link**、**thumbnail**、**fileSize**、**duration**字段必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**document**、**link**、**fileName**、**fileType**字段为必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**text_button**时，**text**、**caption**、**action**字段为必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**text_image_button**时，**text**、**link**、**caption**、**action**字段为必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**text_video**时，**text**、**link**、**thumbnail**、**fileSize**、**duration**字段为必填。</props>'."\n" + .'<props="intl">- 当**messageType**为**text_video_button**时，**text**、**link**、**thumbnail**、**fileSize**、**duration**、**caption**字段为必填，**action**字段不能为值。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "text": "hello,whatsapp",'."\n" + .' "link": "https://*******",'."\n" + .' "caption": "****",'."\n" + .' "fileName": "****"'."\n" + .'}', + ], + ], + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '按钮的触发消息集合。', + 'type' => 'array', + 'items' => [ + 'description' => '模板中按钮的触发消息。', + 'type' => 'string', + 'required' => false, + 'example' => 'payloadtext'."\n", + ], + 'required' => false, + 'example' => 'payloadtext1,payloadtext2,payloadtext3', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV客户wabaId。 过时的参数，请使用CustSpaceId，直客客户实例ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>界面查看。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'cams-8c8*********'."\n", + ], + ], + [ + 'name' => 'FallBackId', + 'in' => 'query', + 'schema' => [ + 'description' => '回落策略ID。该参数为国际站配置参数，中国站可忽略此参数。<props="intl">在[**回落策略**](https://chatapp.console.alibabacloud.com/FallbackStrategy)界面查看策略ID。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'S0****', + ], + ], + [ + 'name' => 'FallBackContent', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义回落内容。该参数为国际站配置参数，中国站可忽略此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'Fallback SMS', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权，已弃用，可忽略此参数。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '123123******', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId ，直客客户实例ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-8c8*********'."\n", + ], + ], + [ + 'name' => 'ContextMessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '回复的消息ID。指原来已发送过或者收到的消息ID。', + 'type' => 'string', + 'required' => false, + 'example' => '61851ccb2f1365b16aee****'."\n", + ], + ], + [ + 'name' => 'TrackingData', + 'in' => 'query', + 'schema' => [ + 'description' => 'Viber消息类型传入的自定义追踪数据，此参数为国际站参数，中国站可忽略此参数', + 'type' => 'string', + 'required' => false, + 'example' => 'Tracking Data', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'description' => 'Viber消息类型，此参数为国际站参数，中国站可忽略此参数。'."\n" + .'<props="intl">取值：</props>'."\n" + .'<props="intl">- **pormotion**：营销、促销类消息。</props>'."\n" + .'<props="intl">- **transaction**：通知类消息。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'promotion', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'description' => 'Viber消息发送超时时间。此参数为国际站参数，中国站可忽略此参数。<props="intl">单位：秒，取值范围 30~1209600。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'description' => '标签信息，Viber消息发送时自定义标签信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'tag', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '10000****', + ], + ], + [ + 'name' => 'FallBackDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '回落触发时间。此参数为国际站参数，中国站可忽略此参数。<props="intl">消息在指定时间内没有返回已到达回执消息时进行回落, 不填代表不根据此时间判断回落，只有发送失败和有失败的状态报告时才会回落。单位：秒。最小值：60，最大值：43200。</props>', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + ], + [ + 'name' => 'ProductAction', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '商品信息，此参数只针对于whatsapp类型通道。即为您在Meta上上传的商品信息。', + 'type' => 'object', + 'properties' => [ + 'ThumbnailProductRetailerId' => [ + 'description' => '商品目录ID。可通过[ListProductCatalog](~~2539783~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'skkks99****', + ], + 'Sections' => [ + 'description' => '商品分类列表（最多可以有10个分类，30个商品）。', + 'type' => 'array', + 'items' => [ + 'description' => '商品分类。', + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '分类名称。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**目录管理**>**商品管理**界面查看或通过[ListProduct](~~2557786~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + 'ProductItems' => [ + 'description' => '商品信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '商品信息。', + 'type' => 'object', + 'properties' => [ + 'ProductRetailerId' => [ + 'description' => '商品ID。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**目录管理**>**商品管理**界面查看或通过[ListProduct](~~2557786~~)接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ksi3****', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'FallBackRule', + 'in' => 'query', + 'schema' => [ + 'description' => '回落规则。此参数为国际站参数，中国站可忽略此参数。'."\n" + .'</props><props="intl">取值：</props>'."\n" + .'<props="intl">- **undelivered**：消息不能发送到端时进行回落（在发送状态时模板、参数需要校验通过，模板被封、号码被封等不做校验）。参数值为空时默认使用此规则。</props>'."\n" + .'<props="intl">- **sentFailed**：消息在校验模板、模板变量等参数时，校验不通过也会进行回落。只会强校验channelType, type, messageType, to, from(是否存在) 几个参数。</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'undelivered', + ], + ], + [ + 'name' => 'FlowAction', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Flow消息对象。', + 'type' => 'object', + 'properties' => [ + 'FlowActionData' => [ + 'description' => 'flow默认参数集合。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + ], + 'example' => '', + ], + 'FlowToken' => [ + 'description' => '自定义flow token信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'kde****', + ], + ], + 'required' => false, + 'example' => 'individual', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**模板设计**界面查看模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'RecipientType', + 'in' => 'query', + 'schema' => [ + 'description' => '收件人类型。取值：'."\n" + ."\n" + .'- individual：个体。'."\n" + ."\n" + .'- group：群组。', + 'type' => 'string', + 'required' => false, + 'example' => 'individual', + 'default' => 'individual', + ], + ], + [ + 'name' => 'MessageCampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '活动消息ID。'."\n" + ."\n" + .'> 该参数为测试参数，未完全开放，请忽略该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '123123********'."\n", + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta广告账户ID。'."\n" + .'> 该参数为测试参数，未完全开放，请忽略该参数。', + 'type' => 'string', + 'required' => false, + 'example' => '123123********', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Token类型。'."\n" + .'> 该参数为测试参数，未完全开放，请忽略该参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'bearer', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866******', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'MessageId' => [ + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '61851ccb2f1365b16aee****', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866******\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"Code\\": \\"OK\\",\\n \\"MessageId\\": \\"61851ccb2f1365b16aee****\\"\\n}","type":"json"}]', + 'title' => '发送ChatApp消息', + 'description' => '- 您可调用此接口发送消息，也可在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**消息发送**界面手动发送消息。'."\n" + ."\n" + .'- 在调用此接口前。请确保您已成功创建通道，且已有审核通过的模板。'."\n" + ."\n" + .'- WhatsApp通道类型需已完成[WABA注册及绑定](~~172335~~)、[新增号码](~~2656131~~)。'."\n" + .'- Messenger通道类型需已完成[连接公共主页账号](~~2837713~~)。'."\n" + .'- Instagram通道类型需已完成[连接专业账户账号](~~2837720~~)。'."\n" + ."\n" + .'<props="intl">- Viber通道类型需已完成[申请服务号](~~2807995~~)。</props>'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为250次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'### 状态变更'."\n" + .'消息发送状态可以通过MNS/HTTP方式监听，具体请参考[回执消息](~~421545~~)。', + ], + 'WhatsappCall' => [ + 'summary' => '呼叫、接听、挂断Whatsapp语音电话。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'autoTest' => false, + 'notSupportAutoTestReason' => '语音需要呼出', + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-xx**', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '呼叫ID', + 'type' => 'string', + 'required' => false, + 'example' => 'wamid-xx**', + ], + ], + [ + 'name' => 'CallAction', + 'in' => 'query', + 'schema' => [ + 'description' => '呼叫动作', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'reject' => 'reject', + 'terminate' => 'terminate', + 'pre_accept' => 'pre_accept', + 'connect' => 'connect', + 'accept' => 'accept', + ], + 'example' => 'connect', + ], + ], + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'required' => true, + 'example' => '86138***', + ], + ], + [ + 'name' => 'UserNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '用户号码', + 'type' => 'string', + 'required' => false, + 'example' => '86131***', + ], + ], + [ + 'name' => 'Session', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '呼叫协商信息', + 'type' => 'object', + 'properties' => [ + 'SdpType' => [ + 'description' => 'sdp类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'offer' => 'offer', + 'answer' => 'answer', + ], + 'example' => 'offer', + ], + 'Sdp' => [ + 'description' => 'sdp', + 'type' => 'string', + 'required' => false, + 'example' => 'v=0\\r\\no=- 3978582128 3978582128 IN IP4 0.0.0.0\\r\\ns=Kurento Media Server\\r\\nc=IN IP4 0.0.0.0\\r\\nt=0 0\\r\\na=group:BUNDLE audio0\\r\\nm=audio 61903 RTP/SAVPF 96 0 8\\r\\na=setup:actpass\\r\\na=extmap:3 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\\r\\na=rtpmap:96 opus/48000/2\\r\\na=rtcp:9 IN IP4 0.0.0.0\\r\\na=rtcp-mux\\r\\na=sendrecv\\r\\na=mid:audio0\\r\\na=ssrc:1935711036 cname:user3617531270@host-126a650\\r\\na=ice-ufrag:/TW8\\r\\na=ice-pwd:GRKrVHYTLGT69PYlqqWQHO\\r\\na=fingerprint:sha-256 41:5C:01:6E:C0:1B:21:F1:0D:28:95:2E:4E:42:F6:64:F3:DB:DD:E3:18:54:32:28:3D:2F:9C:80:38:FA:E0:2Ca=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\\r\\na=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\\r\\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\\r\\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\\r\\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\\r\\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\\r\\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\\r\\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\\r\\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\\r\\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\\r\\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\\r\\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\\r\\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\\r\\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\\r\\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\\r\\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\\r\\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\\r\\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\\r\\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\\r\\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\\r\\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\\r\\n'."\n", + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'xik-x**', + ], + 'Model' => [ + 'description' => '返回结果', + 'type' => 'object', + 'properties' => [ + 'CallId' => [ + 'description' => '每次呼叫的唯一标识', + 'type' => 'string', + 'example' => 'wamid-xx**', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"xik-x**\\",\\n \\"Model\\": {\\n \\"CallId\\": \\"wamid-xx**\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Whatsapp语音电话', + ], + 'CreateChatappTemplate' => [ + 'summary' => '创建消息模板，模板审核通过后可以发送消息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '129141', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板分类', + 'description' => 'Whatsapp模板分类：'."\n" + ."\n" + .'- **UTILITY**：交易相关。'."\n" + ."\n" + .'- **MARKETING**：营销性模板。'."\n" + ."\n" + .'- **AUTHENTICATION**：身份验证。'."\n" + ."\n" + .'Viber模板分类：'."\n" + .'- **text**：纯文本'."\n" + ."\n" + .'- **image**：纯图片'."\n" + ."\n" + .'- **text_image_button**：文本 + 图片 + 按钮'."\n" + ."\n" + .'- **text_button**：文本 + 按钮'."\n" + ."\n" + .'- **document**：文件'."\n" + ."\n" + .'- **video**：视频'."\n" + ."\n" + .'- **text_video**：文本 + 视频'."\n" + ."\n" + .'- **text_video_button**：文本 + 视频 + 按钮'."\n" + ."\n" + .'- **text_image**：文本 + 图片', + 'type' => 'string', + 'required' => true, + 'example' => 'UTILITY', + ], + ], + [ + 'name' => 'Components', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '消息模板组件列表。'."\n" + ."\n" + .'> 在Category=AUTHENTICATION时，Components不允许出现Type=HEADER的节点，并且Type=BODY或FOOTER时，Text内容应该为空。', + 'type' => 'array', + 'items' => [ + 'description' => '组件列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER、FOOTER 和 BUTTONS', + 'description' => '组件类型。取值：'."\n" + ."\n" + .'- **BODY**'."\n" + ."\n" + .'- **HEADER**'."\n" + ."\n" + .'- **FOOTER**'."\n" + ."\n" + .' - **BUTTONS**'."\n" + ."\n" + .'- **CAROUSEL**'."\n" + ."\n" + .'- **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> - WhatsApp类型模板时，**BODY**组件的字符长度不超度是1024个字符。**HEADER**和**FOOTER**组件的字符长度不超过60个字符。'."\n" + .'> - Viber类型模板时，**FOOTER**，**CAROUSEL**，**LIMITED_TIME_OFFER** 类型无效。'."\n" + .'> - Viber类型模板中，图片、视频、文件都是放在**HEADER**中（终端将图片显示在文本之下）。', + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '发送消息的文本。'."\n" + ."\n" + .'> 在Category=AUTHENTICATION中，此属性值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello whatsapp', + ], + 'Format' => [ + 'title' => '格式'."\n" + .'TEXT-文本 IMGAGE-图片 DOCUMENT-文档 VIDEO-视频', + 'description' => '媒体资源类型。'."\n" + ."\n" + .'- **TEXT**：文本'."\n" + .' '."\n" + .'- **IMAGE**：图片'."\n" + ."\n" + .'- **DOCUMENT**：文档'."\n" + ."\n" + .'- **VIDEO**：视频', + 'type' => 'string', + 'required' => false, + 'example' => 'TEXT', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => '素材路径。'."\n" + ."\n" + .'> Viber类型时图片建议大小：800px * 800px。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://image.developer.aliyundoc.com', + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => '文件的描述。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个视频', + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => '文件的名称。', + 'type' => 'string', + 'required' => false, + 'example' => '快递视频', + ], + 'Buttons' => [ + 'title' => '按钮', + 'description' => '按钮列表，仅适用于**BUTTONS**组件。'."\n" + ."\n" + .'> Whatsapp按钮数量说明'."\n" + .'> - Whatsapp在类型为MARKETING/UTILITY时，最多允许10个按钮'."\n" + .'> - PHONE_NUMBER类型的按钮只允许存在1个'."\n" + .'> - URL类型的按钮最多允许存在2个'."\n" + .'> - QUICK_REPLY按钮不允许和PHONE_NUMBER/URL按钮乱序出现', + 'type' => 'array', + 'items' => [ + 'title' => '素材路径', + 'description' => '按钮定义。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型'."\n" + .'PHONE_NUMBER（电话）,URL（网页按钮）和QUICK_REPLY（快速回复）', + 'description' => '按钮类型。'."\n" + ."\n" + .'- **PHONE_NUMBER**：拨打电话按钮'."\n" + ."\n" + .'- **URL**：网页按钮'."\n" + ."\n" + .'- **QUICK_REPLY**：快速回复按钮'."\n" + ."\n" + .'- **COPY_CODE**：复制验证码、优惠码'."\n" + ."\n" + .'- **ONE_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **ZERO_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **MPM**：多商品目录'."\n" + ."\n" + .'- **CATALOG**：目录'."\n" + ."\n" + .'- **FLOW**：打开Whatsapp flow'."\n" + ."\n" + .'> - Whatsapp类型模板且Category为AUTHENTICATION时，按钮只允许存在一个，并且类型只能是COPY_CODE/ONE_TAP, 当类型选择COPY_CODE时，Text为必填。当类型选择ONE_TAP时，Text（在终端没有装目标应用时显示，表示采用复制验证码按钮的名称）必填，SignatureHash, PackageName, AutofillText属性必填。'."\n" + .'> - Viber类型的模板只允许一个Button且只能是URL类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '按钮显示的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'Call Me', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '电话号码，仅按钮类型为**PHONE_NUMBER**时有效。', + 'type' => 'string', + 'required' => false, + 'example' => '+861368897****', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => '点击链接按钮将访问的网址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => '网址类型。'."\n" + ."\n" + .'- **static**：静态'."\n" + ."\n" + .'- **dynamic**：动态', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => '请使用SupportedApps下的属性', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'wi299382', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => '请使用SupportedApps下的属性', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'com.demo', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'Whatsapp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，Whatsap Autofill操作的按钮文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，且在ChatApp已配置了发送控制操作，则后续Marketing消息则不会发送到客户。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => '优惠码值，只支持字母+数字，可以传入变量如$(couponCode)，在发送时再传入优惠码', + 'type' => 'string', + 'required' => false, + 'example' => '120293', + ], + 'FlowId' => [ + 'title' => 'Flow id', + 'description' => 'Flow ID。', + 'type' => 'string', + 'required' => false, + 'example' => '479884093605****', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'Flow数据事件类型。取值：'."\n" + ."\n" + .'- DATA_EXCHANGE：数据交换。'."\n" + ."\n" + .'- NAVIGATE：导航，', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => '跳转屏，在FlowAction=NAVIGATE时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => '支持的APP列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => 'WhatsApp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，表示Whatsapp调起应用的签名Hash值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ieid83kdiek', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => 'WhatsApp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，表示Whatsapp调起应用的包名。', + 'type' => 'string', + 'required' => false, + 'example' => 'com.kuaidian.waimaistaff', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'Viber带视频消息的缩略图。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100', + ], + 'Duration' => [ + 'title' => 'Viber视频消息的视频时长，取值范围 0 - 600', + 'description' => 'Viber视频消息的视频时长(秒)，取值范围为0~600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'Viber文件消息的文件类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'Whatsapp AUTHENTICATION模板验证码有效期（分钟），只在Whatsapp类型消息，Category为AUTHENTICATION并且Component Type为Footer时有效（此信息显示在Footer位置）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'Whatsapp类型模板，Category为AUTHENTICATION且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'HasExpiration' => [ + 'title' => 'LTO模板中，是否有过期时间', + 'description' => '优惠码是否存在过期时间，在type = LIMITED_TIME_OFFER时使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Cards' => [ + 'description' => 'Carousel模板卡片列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel模板卡片对象。', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => 'Carousel模板卡片列表', + 'description' => 'Carousel卡片中控件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel模板中卡片对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER 和 BUTTONS', + 'description' => '组件类型。取值：'."\n" + ."\n" + .'- **BODY**'."\n" + ."\n" + .'- **HEADER**'."\n" + ."\n" + .'- **BUTTONS**', + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => '媒体资源类型，在Type = HEADER时有效。'."\n" + ."\n" + .'- **IMAGE**：图片 '."\n" + ."\n" + .'- **VIDEO**：视频', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + 'Text' => [ + 'title' => 'Carousel轮播卡片中Body的内容', + 'description' => 'Carousel卡片中BODY的内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'Who is the very powerful team', + ], + 'Url' => [ + 'title' => 'Header，图片或视频的路径', + 'description' => '素材路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/img.png', + ], + 'Buttons' => [ + 'title' => 'Carousel卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有2个按钮', + 'description' => '按钮列表，仅适用于BUTTONS组件。Carousel每个卡片最多只能有两个按钮。', + 'type' => 'array', + 'items' => [ + 'description' => '按钮对象。', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'title' => '按钮内容', + 'description' => '按钮文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'Call me', + ], + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => '按钮类型。'."\n" + ."\n" + .'- **PHONE_NUMBER**：拨打电话按钮'."\n" + ."\n" + .'- **URL**：网页按钮'."\n" + ."\n" + .'- **QUICK_REPLY**：快速回复按钮', + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => '点击按钮后将访问的网址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/xx', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => '网址类型 '."\n" + ."\n" + .'- **static**: 静态'."\n" + ."\n" + .'- **dynamic**: 动态', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '电话号码。', + 'type' => 'string', + 'required' => false, + 'example' => '+86138007****', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'hello_whatsapp', + ], + ], + [ + 'name' => 'Language', + 'in' => 'formData', + 'schema' => [ + 'title' => '语言', + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'Example', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '变量，KEY-VALUE结构', + 'description' => '创建模板的示例。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + ], + 'enumValueTitles' => [], + 'example' => 'hello_whatsapp', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'- **VIBER**', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'ISV客户WabaId。'."\n" + ."\n" + .'> 过时的参数，请使用CustSpaceId。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'AllowCategoryChange', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许facebook自动变更模板的目录（这样能提高模板的审核通过率）此属性只对TemplateType=WHATSAPP有效', + 'description' => '是否允许facebook自动变更模板的目录（这样能提高模板的审核通过率）此属性只对TemplateType=WHATSAPP有效。'."\n" + .'><notice>这个属性已被弃用，whatsapp已不支持此属性></notice>', + 'type' => 'boolean', + 'deprecated' => true, + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'MessageSendTtlSeconds', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Whatsapp中Authentication模板消息发送时的有效期', + 'description' => 'WhatsApp中模板消息发送时的有效期。'."\n" + .'- AUTHENTICATION 取值范围为 30 - 900 '."\n" + .'- UTILITY 取值范围为 30 - 43200', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2592000', + 'minimum' => '30', + 'example' => '120', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'description' => 'Utility类型模板变更为Marketing类型时，模板是否暂停发送，属性仅对Whatsapp模板有效', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '提示信息，当返回异常时有值', + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板Code', + 'description' => '模板Code。', + 'type' => 'string', + 'example' => 'SMS_232907****', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + ], + 'example' => '{"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"SMS_232907****\\",\\n \\"TemplateName\\": \\"hello_whatsapp\\"\\n },\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateChatappTemplateResponse>\\n <RequestId>90E63D28-E31D-1EB2-8939-A9486641****</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <Data>{\\"templateCode\\": \\"****4b5c79c9432497a075bdfca36bf5\\"，\\"templateName\\": \\"hello_whatsapp\\"}</Data>\\n</CreateChatappTemplateResponse>","errorExample":""}]', + 'title' => '创建ChatApp模板', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'### 状态变更'."\n" + .'模板的状态和质量变更可以通过MNS/HTTP方式监听，具体请参考[回执消息](~~421545~~)。', + ], + 'ModifyChatappTemplate' => [ + 'summary' => '修改消息模板。只能修改未审核以及审核不通过的模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '155029', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Components', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '消息模板组件列表。'."\n" + ."\n" + .'> 在Category为AUTHENTICATION时，Components不允许出现Type为HEADER的节点，并且Type为BODY/FOOTER时，Text内容为空，会自动生成内容。', + 'type' => 'array', + 'items' => [ + 'description' => '消息模板组件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER、FOOTER 和 BUTTONS', + 'description' => '组件类型。'."\n" + ."\n" + .'- **BODY**'."\n" + ."\n" + .'- **HEADER**'."\n" + ."\n" + .'- **FOOTER**'."\n" + ."\n" + .' - **BUTTONS**'."\n" + ."\n" + .'- **CAROUSEL**'."\n" + ."\n" + .'- **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> - Whatsapp类型模板时，**BODY**组件的字符长度不超度是1024个字符。**HEADER**和**FOOTER**组件的字符长度不超过60个字符。'."\n" + .'> - Viber类型模板时，**FOOTER**，**CAROUSEL**，**LIMITED_TIME_OFFER** 类型无效。'."\n" + .'> - Viber类型模板中，图片、视频、文件都是放在**HEADER**中（终端将图片显示在文本之下）。', + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '所发送消息的文本。'."\n" + ."\n" + .'> 在Category=AUTHENTICATION中，此属性值为空。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello chatapp', + ], + 'Format' => [ + 'title' => '格式'."\n" + .'TEXT-文本 IMGAGE-图片 DOCUMENT-文档 VIDEO-视频', + 'description' => '媒体资源类型。'."\n" + ."\n" + .'- **TEXT**: 文本 '."\n" + ."\n" + .'- **IMAGE**: 图片 '."\n" + ."\n" + .'- **DOCUMENT**: 文档 '."\n" + ."\n" + .'- **VIDEO**: 视频', + 'type' => 'string', + 'required' => false, + 'example' => 'TEXT', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => '素材路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://img.****.com/png_preview/00/10/24/1GygxVK3F4.jpg', + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => '描述。'."\n" + .'> 当Type为**HEADER**，且Format为**IMAGE/DOCUMENT/VIDEO**时可以增加描述。', + 'type' => 'string', + 'required' => false, + 'example' => '这是一个视频', + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => '文件名称。'."\n" + .'> 当Type为**HEADER**，且Format为**DOCUMENT**时为文件指定文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => '视频', + ], + 'Buttons' => [ + 'title' => '按钮', + 'description' => '按钮列表，仅适用于**BUTTONS**组件。'."\n" + ."\n" + .'> Whatsapp按钮数量说明'."\n" + .'> - Whatsapp在类型为MARKETING/UTILITY时，最多允许10个按钮'."\n" + .'> - PHONE_NUMBER类型的按钮只允许存在1个'."\n" + .'> - URL类型的按钮最多允许存在2个'."\n" + .'> - QUICK_REPLY按钮不允许和PHONE_NUMBER/URL按钮乱序出现', + 'type' => 'array', + 'items' => [ + 'title' => '素材路径', + 'description' => '按钮定义。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型'."\n" + .'PHONE_NUMBER（电话）,URL（网页按钮）和QUICK_REPLY（快速回复）', + 'description' => '按钮类型。'."\n" + ."\n" + .'- **PHONE_NUMBER**：拨打电话按钮'."\n" + ."\n" + .'- **URL**：网页按钮'."\n" + ."\n" + .'- **QUICK_REPLY**：快速回复按钮'."\n" + ."\n" + .'- **COPY_CODE**：复制验证码、优惠码'."\n" + ."\n" + .'- **ONE_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **ZERO_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **MPM**：多商品目录'."\n" + ."\n" + .'- **CATALOG**：目录'."\n" + ."\n" + .'- **FLOW**：打开Whatsapp flow'."\n" + ."\n" + .'> - Whatsapp类型模板且Category为AUTHENTICATION时，按钮只允许存在一个，并且类型只能是COPY_CODE/ONE_TAP, 当类型选择COPY_CODE时，Text为必填。当类型选择ONE_TAP时，Text（在终端没有装目标应用时显示，表示采用复制验证码按钮的名称）必填，SignatureHash, PackageName, AutofillText属性必填。'."\n" + .'> - Viber类型的模板只允许一个Button且只能是URL类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '按钮文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'phone-button-text', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '号码。', + 'type' => 'string', + 'required' => false, + 'example' => '+861388888****', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => '点击按钮后将访问的网址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.website.com/***', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => '网址类型。'."\n" + ."\n" + .'- **static**：静态'."\n" + ."\n" + .'- **dynamic**：动态', + 'type' => 'string', + 'required' => false, + 'example' => 'dynamic', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => '请使用SupportedApps下的属性', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '29dkeke', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => '请使用SupportedApps下的属性', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'com.demo', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'WhatsApp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，Whatsap Autofill操作的按钮文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'WhatsApp模板，在Category为Marketing且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在ChatApp已配置发送控制操作，则后续Marketing消息则不会发送到客户。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => '优惠码值，只支持字母+数字，可以传入变量如$(couponCode)，在发送时再传入优惠码。', + 'type' => 'string', + 'required' => false, + 'example' => '120293', + ], + 'FlowId' => [ + 'title' => 'Flow id', + 'description' => 'Flow ID。', + 'type' => 'string', + 'required' => false, + 'example' => '664597077870605', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'Flow数据事件类型。取值：'."\n" + ."\n" + .'- DATA_EXCHANGE：数据交换。'."\n" + ."\n" + .'- NAVIGATE：导航。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => '跳转屏，在FlowAction=NAVIGATE时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => '支持的APP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的APP列表。', + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => 'Whatsapp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，表示Whatsapp调起应用的签名Hash值。', + 'type' => 'string', + 'required' => false, + 'example' => 'fk39kd93ks9', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => 'Whatsapp模板，Category为AUTHENTICATION且Button Type为ONE_TAP/ZERO_TAP时必填，表示Whatsapp调起应用的包名。', + 'type' => 'string', + 'required' => false, + 'example' => 'com.example.myapplication', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'Viber带视频消息的缩略图。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100', + ], + 'Duration' => [ + 'title' => 'Viber视频消息的视频时长，取值范围 0 - 600', + 'description' => 'Viber视频消息的视频时长，取值范围：0~600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'Viber文件消息的文件类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'Whatsapp AUTHENTICATION模板验证码有效期（分钟），只在Whatsapp类型消息，Category为AUTHENTICATION并且Component Type为Footer时有效（此信息显示在Footer位置）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'Whatsapp类型模板，Category为AUTHENTICATION且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HasExpiration' => [ + 'title' => 'LTO模板中，是否有过期时间', + 'description' => '优惠码是否存在过期时间，在type = LIMITED_TIME_OFFER时使用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Cards' => [ + 'description' => 'Carousel模板卡片列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel模板卡片列表。', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => 'Carousel卡片中的控件列表', + 'description' => 'Carousel卡片中控件列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel卡片中控件列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER 和 BUTTONS', + 'description' => '组件类型。取值：'."\n" + ."\n" + .'- **BODY**'."\n" + ."\n" + .'- **HEADER**'."\n" + ."\n" + .'- **BUTTONS**', + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => '媒体资源类型，在Type = HEADER时有效'."\n" + ."\n" + .'- **IMAGE**: 图片 '."\n" + ."\n" + .'- **VIDEO**: 视频', + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + 'Text' => [ + 'title' => 'Carousel轮播卡片中Body的内容', + 'description' => 'Carousel 卡片中BODY的内容', + 'type' => 'string', + 'required' => false, + 'example' => 'Who is the very powerful team', + ], + 'Url' => [ + 'title' => 'Header，图片或视频的路径', + 'description' => '素材路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/****/img.png'."\n", + ], + 'Buttons' => [ + 'title' => 'Carousel卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有2个按钮', + 'description' => '按钮列表，仅适用于BUTTONS组件。Carousel每个卡片最多只能有两个按钮。', + 'type' => 'array', + 'items' => [ + 'description' => '按钮对象。', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'title' => '按钮内容', + 'description' => '按钮文本。', + 'type' => 'string', + 'required' => false, + 'example' => 'Call me', + ], + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => '按钮类型。'."\n" + ."\n" + .'- **PHONE_NUMBER**：拨打电话按钮'."\n" + ."\n" + .'- **URL**：网页按钮'."\n" + ."\n" + .'- **QUICK_REPLY**：快速回复按钮', + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => '点击按钮后将访问的网址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/xx'."\n", + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => '网址类型。'."\n" + ."\n" + .'- **static**：静态'."\n" + ."\n" + .'- **dynamic**：动态', + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '电话号码。', + 'type' => 'string', + 'required' => false, + 'example' => '+861368893****'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Language', + 'in' => 'formData', + 'schema' => [ + 'title' => '语言', + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'Example', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '变量，KEY-VALUE结构', + 'description' => '创建模板的示例。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"textVariable":"text"}'."\n", + 'description' => '变量例子。通过把JSON结构转成String的方式传入。', + ], + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'ISV客户WabaId。'."\n" + ."\n" + .'> 过时的参数，请使用CustSpaceId。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'ksiekdki39ksks93939', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息模板编码', + 'description' => '消息模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '8472929283883', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Viber修改模板时，可以修改模板Category(Whatsapp修改时此参数无效）', + 'description' => 'Viber模板分类'."\n" + .'- **text**：纯文本'."\n" + ."\n" + .'- **image**：纯图片'."\n" + ."\n" + .'- **text\\_image_button**：文本 + 图片 + 按钮'."\n" + ."\n" + .'- **text_button**：文本 + 按钮'."\n" + ."\n" + .'- **document**： 文件'."\n" + ."\n" + .'- **video**：视频'."\n" + ."\n" + .'- **text_video**：文本 + 视频'."\n" + ."\n" + .'- **text\\_video_button**：文本 + 视频 + 按钮'."\n" + ."\n" + .'- **text_image**：文本 + 图片'."\n" + ."\n" + .'> 此属性只对Viber类型模板有效。', + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改模板的模板类型，取值为WHATSAPP/VIBER， 当未传递此值时，默认值为WHATSAPP', + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'- **VIBER**', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'MessageSendTtlSeconds', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Whatsapp中Authentication模板消息发送有效期', + 'description' => 'WhatsApp中模板消息发送时的有效期。'."\n" + .'- AUTHENTICATION 取值范围为 30 - 900 '."\n" + .'- UTILITY 取值范围为 30 - 43200', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2592000', + 'minimum' => '30', + 'example' => '120', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'description' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '提示信息，当返回异常时有值', + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板Code', + 'description' => '模板Code。', + 'type' => 'string', + 'example' => '8472929283883', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"无\\",\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"8472929283883\\",\\n \\"TemplateName\\": \\"hello_whatsapp\\"\\n },\\n \\"AccessDeniedDetail\\": \\"无\\"\\n}","type":"json"}]', + 'title' => '修改ChatApp模板', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。'."\n" + ."\n" + .'### 状态变更'."\n" + .'模板的状态和质量变更可以通过MNS/HTTP方式监听，具体请参考[回执消息](~~421545~~)。', + ], + 'ListChatappTemplate' => [ + 'summary' => '获取消息模板列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '129139', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'hello_whatsapp', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '审核状态。取值：'."\n" + ."\n" + .'- **pass**：通过审核。'."\n" + ."\n" + .'- **fail**：拒绝审核。'."\n" + ."\n" + .'- **auditing**：审核中。'."\n" + ."\n" + .'- **unaudit**：审核暂停处理。', + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页字段。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每次查询模板数量，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + ], + 'Index' => [ + 'description' => '页码，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '"page": "{\\"index\\": 1,\\"size\\": 20}', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV客户WabaId'."\n" + ."\n" + .'> 过时的参数，请使用CustSpaceId。', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****'."\n", + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'- **VIBER**', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '838888822*****', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '模板分类', + 'type' => 'string', + 'required' => false, + 'example' => 'AUTHENTICATION', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'ListTemplate' => [ + 'description' => '列表数据。', + 'type' => 'array', + 'items' => [ + 'description' => '模板列表。', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'AuditStatus' => [ + 'description' => '审核状态。取值：'."\n" + ."\n" + .'- **pass**：通过审核。'."\n" + ."\n" + .'- **fail**：拒绝审核。'."\n" + ."\n" + .'- **auditing**：审核中。'."\n" + ."\n" + .'- **unaudit**：审核暂停处理。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Category' => [ + 'description' => 'Whatsapp模板分类。取值：'."\n" + ."\n" + .'- **UTILITY**：交易相关。'."\n" + ."\n" + .'- **MARKETING**：营销性模板。'."\n" + ."\n" + .'- **AUTHENTICATION**：身份验证。'."\n" + ."\n" + .'Viber模板分类'."\n" + .'- **text**：纯文本'."\n" + ."\n" + .'- **image**：纯图片'."\n" + ."\n" + .'- **text_image_button**：文本 + 图片 + 按钮'."\n" + ."\n" + .'- **text_button**：文本 + 按钮'."\n" + ."\n" + .'- **document**： 文件'."\n" + ."\n" + .'- **video**：视频'."\n" + ."\n" + .'- **text_video**：文本 + 视频'."\n" + ."\n" + .'- **text_video_button**：文本 + 视频 + 按钮'."\n" + ."\n" + .'- **text_image**：文本 + 图片', + 'type' => 'string', + 'example' => 'UTILITY', + ], + 'Language' => [ + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'example' => 'en', + ], + 'LastUpdateTime' => [ + 'description' => '最后修改时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711006633000', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + 'TemplateType' => [ + 'description' => '模板类型，取值为WHATSAPP或VIBER。', + 'type' => 'string', + 'example' => 'WHATSAPP', + ], + 'Reason' => [ + 'description' => '模板审核被拒的原因。', + 'type' => 'string', + 'example' => 'None', + ], + ], + ], + 'example' => '', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"ListTemplate\\": [\\n {\\n \\"TemplateCode\\": \\"744c4b5c79c9432497a075bdfca3****\\",\\n \\"AuditStatus\\": \\"pass\\",\\n \\"Category\\": \\"UTILITY\\",\\n \\"Language\\": \\"en\\",\\n \\"LastUpdateTime\\": 1711006633000,\\n \\"TemplateName\\": \\"hello_whatsapp\\",\\n \\"TemplateType\\": \\"WHATSAPP\\",\\n \\"Reason\\": \\"None\\"\\n }\\n ],\\n \\"Total\\": 1,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"<ListChatappTemplateResponse>\\n <RequestId>90E63D28-E31D-1EB2-8939-A9486641****</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <ListTemplate>\\n <TemplateName>hello_whatsapp</TemplateName>\\n <TemplateCode>744c4b5c79c9432497a075bdfca3****</TemplateCode>\\n <AuditStatus>APPROVED</AuditStatus>\\n <Language>en</Language>\\n <Category>ACCOUNT_UPDATE</Category>\\n </ListTemplate>\\n</ListChatappTemplateResponse>","errorExample":""}]', + 'title' => '查询ChatApp模板列表', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetChatappTemplateDetail' => [ + 'summary' => '获取消息模板的详细信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '129127', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '模板分类', + 'description' => '模板Code。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****4b5c79c9432497a075bdfca36bf5', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'en_US', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'ISV客户WabaId。'."\n" + ."\n" + .'> 过时的参数，请使用CustSpaceId', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****'."\n", + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '模板的模板类型，取值为WHATSAPP/VIBER， 当未传递此值时，默认值为WHATSAPP', + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'- **VIBER**', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Data' => [ + 'title' => 'TemplateDetail', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '模板分类', + 'description' => 'Whatsapp模板分类。取值：'."\n" + ."\n" + .'- **UTILITY**：交易相关。'."\n" + ."\n" + .'- **MARKETING**：营销性模板。'."\n" + ."\n" + .'- **AUTHENTICATION**：身份验证。'."\n" + ."\n" + .'Viber模板分类'."\n" + .'- **text**：纯文本'."\n" + ."\n" + .'- **image**：纯图片'."\n" + ."\n" + .'- **text\\_image_button**：文本 + 图片 + 按钮'."\n" + ."\n" + .'- **text_button**：文本 + 按钮'."\n" + ."\n" + .'- **document**： 文件'."\n" + ."\n" + .'- **video**：视频'."\n" + ."\n" + .'- **text_video**：文本 + 视频'."\n" + ."\n" + .'- **text\\_video_button**：文本 + 视频 + 按钮'."\n" + ."\n" + .'- **text_image**：文本 + 图片'."\n" + ."\n" + .'> 当Viber模板取值为text_video_button时，按钮并不能打开网页，只是在网页中打开当前消息的视频，所以按钮的URL中不需要填写任何地址信息', + 'type' => 'string', + 'example' => 'UTILITY', + ], + 'TemplateCode' => [ + 'title' => '模板编码', + 'description' => '模板Code。', + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Name' => [ + 'title' => '模板名称', + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + 'Language' => [ + 'title' => '语言', + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'example' => 'en_US', + ], + 'Example' => [ + 'title' => '变量例子', + 'description' => '变量举例。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '模板变量对应的实际值，参数格式为JSON格式。', + 'example' => '{\\"textVariable\\":\\"text\\",\\"linkVariable\\":\\"https://image.developer.aliy\\"}', + ], + ], + 'AuditStatus' => [ + 'title' => '审核状态', + 'description' => '审核状态。取值：'."\n" + ."\n" + .'- **pass**：通过审核。'."\n" + ."\n" + .'- **fail**：拒绝审核。'."\n" + ."\n" + .'- **auditing**：审核中。'."\n" + ."\n" + .'- **unaudit**：审核暂停处理。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Components' => [ + 'title' => '消息模板组件', + 'description' => '消息模板组件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '消息模板组件。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型', + 'description' => '组件类型。'."\n" + ."\n" + .'- **BODY**'."\n" + ."\n" + .'- **HEADER**'."\n" + ."\n" + .'- **FOOTER**'."\n" + ."\n" + .' - **BUTTONS**'."\n" + ."\n" + .'- **CAROUSEL**'."\n" + ."\n" + .'- **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> - WhatsApp类型模板时，**BODY**组件的字符长度不超度是1024个字符。**HEADER**和**FOOTER**组件的字符长度不超过60个字符。'."\n" + .'> - Viber类型模板时，**FOOTER**，**CAROUSEL**，**LIMITED_TIME_OFFER** 类型无效。'."\n" + .'> - Viber类型模板中，图片、视频、文件都是放在**HEADER**中（终端将图片显示在文本之下）。', + 'type' => 'string', + 'example' => 'BODY', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => '素材路径。', + 'type' => 'string', + 'example' => 'https://image.developer.aliyundoc.com', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '发送消息的文本。', + 'type' => 'string', + 'example' => '你好', + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => '文件的描述。', + 'type' => 'string', + 'example' => '新文件已上传', + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => '文件的名称。', + 'type' => 'string', + 'example' => '快递文件', + ], + 'Format' => [ + 'title' => '格式', + 'description' => '格式。', + 'type' => 'string', + 'example' => 'TEXT', + ], + 'Buttons' => [ + 'title' => '仅适用于 BUTTONS 类型。'."\n" + .'与按钮相关的参数。', + 'description' => '按钮列表，仅适用于**BUTTONS**组件。'."\n" + ."\n" + .'> Whatsapp按钮数量说明'."\n" + .'> - Whatsapp在类型为MARKETING/UTILITY时，最多允许10个按钮'."\n" + .'> - PHONE_NUMBER类型的按钮只允许存在1个'."\n" + .'> - URL类型的按钮最多允许存在2个'."\n" + .'> - QUICK_REPLY按钮不允许和PHONE_NUMBER/URL按钮乱序出现', + 'type' => 'array', + 'items' => [ + 'description' => '组件列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型', + 'description' => '按钮类型。'."\n" + ."\n" + .'- **PHONE_NUMBER**：拨打电话按钮'."\n" + ."\n" + .'- **URL**：网页按钮'."\n" + ."\n" + .'- **QUICK_REPLY**：快速回复按钮'."\n" + ."\n" + .'- **COPY_CODE**：复制验证码、优惠码'."\n" + ."\n" + .'- **ONE_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **ZERO_TAP**：AUTHENTICATION模板时回填按钮'."\n" + ."\n" + .'- **MPM**：多商品目录'."\n" + ."\n" + .'- **CATALOG**：目录'."\n" + ."\n" + .'- **FLOW**：打开Whatsapp flow'."\n" + ."\n" + .'> - Whatsapp类型模板且Category为AUTHENTICATION时，按钮只允许存在一个，并且类型只能是COPY_CODE/ONE_TAP, 当类型选择COPY_CODE时，Text为必填。当类型选择ONE_TAP时，Text（在终端没有装目标应用时显示，表示采用复制验证码按钮的名称）必填，SignatureHash, PackageName, AutofillText属性必填。'."\n" + .'> - Viber类型的模板只允许一个Button且只能是URL类型。', + 'type' => 'string', + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => '按钮显示的名称。', + 'type' => 'string', + 'example' => '打电话', + ], + 'PhoneNumber' => [ + 'title' => '电话号码', + 'description' => '电话号码，仅按钮类型为**PHONE_NUMBER**时有效。', + 'type' => 'string', + 'example' => '+861398745****', + ], + 'Url' => [ + 'title' => '当按钮类型是'."\n" + .'URL 时有效', + 'description' => '点击链接按钮将访问的网址。', + 'type' => 'string', + 'example' => 'https://example.com'."\n", + ], + 'UrlType' => [ + 'title' => 'WEB地址类型'."\n" + .'static-静态'."\n" + .'dynamic-动态', + 'description' => '网址类型。'."\n" + ."\n" + .'- **static**：静态。'."\n" + ."\n" + .'- **dynamic**：动态。', + 'type' => 'string', + 'example' => 'static', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => 'WhatsApp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值。', + 'type' => 'string', + 'example' => '2993839', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => 'WhatsApp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名。', + 'type' => 'string', + 'example' => 'com.aliyun', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'WhatsApp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本。', + 'type' => 'string', + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'WhatsApp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExtendAttrs' => [ + 'title' => '扩展字段', + 'description' => '扩展字段。', + 'type' => 'object', + 'properties' => [ + 'NextTemplateCode' => [ + 'title' => '下一个模板编码', + 'description' => '下一个模板编码。', + 'type' => 'string', + 'example' => '20939920093993', + ], + 'NextTemplateName' => [ + 'title' => '下一个模板名称', + 'description' => '下一个模板名称。', + 'type' => 'string', + 'example' => 'abc', + ], + 'NextLanguageCode' => [ + 'title' => '下一个模板语言', + 'description' => '下一个模板语言。', + 'type' => 'string', + 'example' => 'en', + ], + 'Action' => [ + 'title' => '事件类型', + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'nextCard', + ], + 'IntentCode' => [ + 'title' => '意图编码', + 'description' => '意图编码。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => '优惠券码。', + 'type' => 'string', + 'example' => '202039ksjs', + ], + 'FlowId' => [ + 'title' => 'Flow ID', + 'description' => 'Flow ID。', + 'type' => 'string', + 'example' => '3838292983', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'Flow数据事件类型，取值：'."\n" + ."\n" + .'- NAVIGATE：导航'."\n" + ."\n" + .'- DATA_EXCHANGE：数据交换', + 'type' => 'string', + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => '跳转屏，在FlowAction=NAVIGATE时必填。', + 'type' => 'string', + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => '验证码ONE_TAP/ZERO_TAP支持的应用。', + 'type' => 'array', + 'items' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => '验证码ONE_TAP/ZERO_TAP支持的应用。', + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => '包签名HASH。', + 'type' => 'string', + 'example' => '29kdkeik939', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => '包名。', + 'type' => 'string', + 'example' => 'com.test', + ], + ], + ], + ], + ], + ], + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'Viber带视频消息的缩略图。', + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'Duration' => [ + 'title' => 'Viber视频消息的视频时长，取值范围 0 - 600', + 'description' => 'Viber视频消息的视频时长，取值范围：0~600。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'Viber文件消息的文件类型。', + 'type' => 'string', + 'example' => 'docx', + ], + 'Latitude' => [ + 'title' => '位置纬度属性', + 'description' => '位置纬度属性。', + 'type' => 'string', + 'example' => '28.001', + ], + 'Longitude' => [ + 'title' => '位置经度属性', + 'description' => '位置经度属性。', + 'type' => 'string', + 'example' => '120.002', + ], + 'LocationName' => [ + 'title' => '位置名称', + 'description' => '位置名称。', + 'type' => 'string', + 'example' => '杭州', + ], + 'LocationAddress' => [ + 'title' => '位置地址', + 'description' => '位置地址。', + 'type' => 'string', + 'example' => '杭州', + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'WhatsApp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'WhatsApp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'hasExpiration' => [ + 'title' => 'LTO模板中，优惠码是否有过期时间', + 'description' => 'LTO模板中，优惠码是否有过期时间。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'OfferExpirationTimeMs' => [ + 'title' => 'LTO模板时，优惠码过期变量', + 'description' => 'LTO模板时，优惠码过期变量。', + 'type' => 'string', + 'example' => '$(offerExpirationTimeMs)', + ], + 'Cards' => [ + 'title' => '轮播卡片列表', + 'description' => '轮播卡片列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel模板卡片列表。', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => '卡片控件列表', + 'description' => '卡片控件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Carousel卡片中控件列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型', + 'description' => '组件类型。', + 'type' => 'string', + 'example' => 'HEADER', + ], + 'Text' => [ + 'title' => '卡片文本内容', + 'description' => '卡片文本内容。', + 'type' => 'string', + 'example' => 'Body', + ], + 'Url' => [ + 'title' => '网页地址', + 'description' => '网页地址。', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致。', + 'type' => 'string', + 'example' => 'HEADER', + ], + 'Buttons' => [ + 'title' => '卡片按钮列表', + 'description' => '卡片按钮列表', + 'type' => 'array', + 'items' => [ + 'description' => '按钮对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'type' => 'string', + 'example' => 'URL', + ], + 'Text' => [ + 'title' => '按钮内容', + 'description' => '按钮内容。', + 'type' => 'string', + 'example' => '按钮文本', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => '点击按钮后将访问的网址。', + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => '网址类型。取值：'."\n" + .' '."\n" + .'- static：静态'."\n" + ."\n" + .'- dynamic：动态。', + 'type' => 'string', + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '号码。', + 'type' => 'string', + 'example' => '+861380005****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + 'TemplateType' => [ + 'title' => '模板类型，取值为WHATSAPP/VIBER', + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**'."\n" + ."\n" + .'- **VIBER**', + 'type' => 'string', + 'example' => 'WHATSAPP', + ], + 'QualityScore' => [ + 'title' => '模板质量', + 'description' => '模板质量。', + 'type' => 'string', + 'enumValueTitles' => [ + 'RED' => '低质量', + 'YELLOW' => '中等质量', + 'UNKNOWN' => '质量未知', + 'GREEN' => '高质量', + ], + 'example' => 'GREEN', + ], + 'MessageSendTtlSeconds' => [ + 'title' => 'Whatsapp中Authentication类型模板发送消息时的消息有效期', + 'description' => 'Whatsapp中Authentication类型模板发送消息时的消息有效期。', + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '600', + 'minimum' => '60', + 'example' => '120', + ], + 'Reason' => [ + 'title' => '模板审核审核被拒的原因', + 'description' => '模板审核被拒的原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'CategoryChangePaused' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'description' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'type' => 'boolean', + ], + 'AllowSend' => [ + 'title' => '当前模板是否能发送（仅对Marketing模板有效)', + 'description' => '当前模板是否能发送（仅对Marketing模板有效)', + 'type' => 'boolean', + ], + ], + 'example' => '{ "category": "ACCOUNT_UPDATE", "name": "account_notice", "language": "en_US", "templateCode": "744c4b5c79c9432497a075bdfca3****", "auditStatus": "APPROVED", "components": "[{\\"type\\":\\"BODY\\",\\"text\\":\\"body_text$(textVariable)\\"},{\\"type\\":\\"HEADER\\",\\"formate\\":\\"IMAGE\\",\\"url\\":\\"$(linkVariable)\\"},{\\"type\\":\\"FOOTER\\",\\"text\\":\\"footer-text\\"},{\\"type\\":\\"BUTTONS\\",\\"buttons\\":[{\\"type\\":\\"PHONE_NUMBER\\",\\"text\\":\\"phone-button-text\\",\\"phone_number\\":\\"+861388888****\\"},{\\"type\\":\\"URL\\",\\"text\\":\\"url-button-text\\",\\"url\\":\\"https://www.website.com/\\"}]}]", "example": "{\\"textVariable\\": \\"text\\", \\"linkVariable\\": \\"link\\"}" }', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + ], + ], + ], + [], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"744c4b5c79c9432497a075bdfca3****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"Data\\": {\\n \\"Category\\": \\"UTILITY\\",\\n \\"TemplateCode\\": \\"744c4b5c79c9432497a075bdfca3****\\",\\n \\"Name\\": \\"hello_whatsapp\\",\\n \\"Language\\": \\"en_US\\",\\n \\"Example\\": {\\n \\"key\\": \\"{\\\\\\\\\\\\\\"textVariable\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"linkVariable\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://image.developer.aliy\\\\\\\\\\\\\\"}\\"\\n },\\n \\"AuditStatus\\": \\"pass\\",\\n \\"Components\\": [\\n {\\n \\"Type\\": \\"BODY\\",\\n \\"Url\\": \\"https://image.developer.aliyundoc.com\\",\\n \\"Text\\": \\"你好\\",\\n \\"Caption\\": \\"新文件已上传\\",\\n \\"FileName\\": \\"快递文件\\",\\n \\"Format\\": \\"TEXT\\",\\n \\"Buttons\\": [\\n {\\n \\"Type\\": \\"PHONE_NUMBER\\",\\n \\"Text\\": \\"打电话\\",\\n \\"PhoneNumber\\": \\"+861398745****\\",\\n \\"Url\\": \\"https://example.com\\\\n\\",\\n \\"UrlType\\": \\"static\\",\\n \\"SignatureHash\\": \\"2993839\\",\\n \\"PackageName\\": \\"com.aliyun\\",\\n \\"AutofillText\\": \\"Autofill\\",\\n \\"IsOptOut\\": false,\\n \\"ExtendAttrs\\": {\\n \\"NextTemplateCode\\": \\"20939920093993\\",\\n \\"NextTemplateName\\": \\"abc\\",\\n \\"NextLanguageCode\\": \\"en\\",\\n \\"Action\\": \\"nextCard\\",\\n \\"IntentCode\\": \\"test\\"\\n },\\n \\"CouponCode\\": \\"202039ksjs\\",\\n \\"FlowId\\": \\"3838292983\\",\\n \\"FlowAction\\": \\"NAVIGATE\\",\\n \\"NavigateScreen\\": \\"DETAILS\\",\\n \\"SupportedApps\\": [\\n {\\n \\"SignatureHash\\": \\"29kdkeik939\\",\\n \\"PackageName\\": \\"com.test\\"\\n }\\n ]\\n }\\n ],\\n \\"ThumbUrl\\": \\"https://img.png\\",\\n \\"Duration\\": 50,\\n \\"FileType\\": \\"docx\\",\\n \\"Latitude\\": \\"28.001\\",\\n \\"Longitude\\": \\"120.002\\",\\n \\"LocationName\\": \\"杭州\\",\\n \\"LocationAddress\\": \\"杭州\\",\\n \\"AddSecretRecommendation\\": false,\\n \\"CodeExpirationMinutes\\": 5,\\n \\"hasExpiration\\": true,\\n \\"OfferExpirationTimeMs\\": \\"$(offerExpirationTimeMs)\\",\\n \\"Cards\\": [\\n {\\n \\"CardComponents\\": [\\n {\\n \\"Type\\": \\"HEADER\\",\\n \\"Text\\": \\"Body\\",\\n \\"Url\\": \\"https://aliyun.com\\",\\n \\"Format\\": \\"HEADER\\",\\n \\"Buttons\\": [\\n {\\n \\"Type\\": \\"URL\\",\\n \\"Text\\": \\"按钮文本\\",\\n \\"Url\\": \\"https://aliyun.com\\",\\n \\"UrlType\\": \\"static\\",\\n \\"PhoneNumber\\": \\"+861380005****\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TemplateType\\": \\"WHATSAPP\\",\\n \\"QualityScore\\": \\"GREEN\\",\\n \\"MessageSendTtlSeconds\\": 120,\\n \\"Reason\\": \\"None\\",\\n \\"CategoryChangePaused\\": true,\\n \\"AllowSend\\": true\\n },\\n \\"AccessDeniedDetail\\": \\"无\\"\\n}","errorExample":""},{"type":"xml","example":"<GetChatappTemplateDetailResponse>\\n <RequestId>744c4b5c79c9432497a075bdfca3****</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n <Data>{ \\t\\t\\"category\\": \\"ACCOUNT_UPDATE\\", \\t\\t\\"name\\": \\"account_notice\\", \\t\\t\\"language\\": \\"en_US\\", \\t\\t\\"templateCode\\": \\"744c4b5c79c9432497a075bdfca3****\\", \\t\\t\\"auditStatus\\": \\"APPROVED\\", \\t\\t\\"components\\": \\"[{\\\\\\"type\\\\\\":\\\\\\"BODY\\\\\\",\\\\\\"text\\\\\\":\\\\\\"body_text$(textVariable)\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"HEADER\\\\\\",\\\\\\"formate\\\\\\":\\\\\\"IMAGE\\\\\\",\\\\\\"url\\\\\\":\\\\\\"$(linkVariable)\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"FOOTER\\\\\\",\\\\\\"text\\\\\\":\\\\\\"footer-text\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"BUTTONS\\\\\\",\\\\\\"buttons\\\\\\":[{\\\\\\"type\\\\\\":\\\\\\"PHONE_NUMBER\\\\\\",\\\\\\"text\\\\\\":\\\\\\"phone-button-text\\\\\\",\\\\\\"phone_number\\\\\\":\\\\\\"+861388888****\\\\\\"},{\\\\\\"type\\\\\\":\\\\\\"URL\\\\\\",\\\\\\"text\\\\\\":\\\\\\"url-button-text\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://www.website.com/\\\\\\"}]}]\\", \\t\\t\\"example\\": \\"{\\\\\\"textVariable\\\\\\": \\\\\\"text\\\\\\", \\\\\\"linkVariable\\\\\\": \\\\\\"link\\\\\\"}\\" \\t}</Data>\\n</GetChatappTemplateDetailResponse>","errorExample":""}]', + 'title' => '查询ChatApp模板详情', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteChatappTemplate' => [ + 'summary' => '删除消息模板。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '129140', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV客户WabaId。'."\n" + ."\n" + .'> 过时的参数，请使用CustSpaceId', + 'type' => 'string', + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型，当带语言删除时templateType为必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"User not authorized to operate on the specified resource.\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteChatappTemplateResponse>\\n <RequestId>90E63D28-E31D-1EB2-8939-A9486641****</RequestId>\\n <Code>OK</Code>\\n <Message>无</Message>\\n</DeleteChatappTemplateResponse>","errorExample":""}]', + 'title' => '删除ChatApp模板', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListProductCatalog' => [ + 'summary' => '查询Meta Business平台的目录列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BusinessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA所在的商业平台ID。可在Chat App消息服务控制台WABA注册完成后查看商业平台ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '105048970863****', + ], + ], + [ + 'name' => 'Before', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页的前一页结束位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'wiidkd939kek93', + ], + ], + [ + 'name' => 'After', + 'in' => 'query', + 'schema' => [ + 'description' => '翻页时下一页开始位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'kdkii48jfjjei3', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => '字段列表，多个字段用半角逗号（,）隔开。'."\n" + .'具体字段请参考 [目录字段](~~2579419~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'id,name', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数量。取值范围[1,1000]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '73', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'C29398882929', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Paging' => [ + 'description' => '分页详情。', + 'type' => 'object', + 'properties' => [ + 'Cursors' => [ + 'description' => '翻页位置。', + 'type' => 'object', + 'properties' => [ + 'Before' => [ + 'description' => '前一条记录位置。', + 'type' => 'string', + 'example' => 'sjjsjdjjdjd83883', + ], + 'After' => [ + 'description' => '后一条记录位置。', + 'type' => 'string', + 'example' => 'sjsuueu83838', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'example' => '{"id":"2999293993", "name":"catalog_name"}', + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Model\\": {\\n \\"Paging\\": {\\n \\"Cursors\\": {\\n \\"Before\\": \\"sjjsjdjjdjd83883\\",\\n \\"After\\": \\"sjsuueu83838\\"\\n }\\n },\\n \\"Data\\": [\\n {\\n \\"id\\": \\"2999293993\\",\\n \\"name\\": \\"catalog_name\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '商品目录列表', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetWhatsappConnectionCatalog' => [ + 'summary' => '获取Waba关联的目录。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA账号ID。可在Chat App消息服务控制台WABA注册完成后查看WabaId。', + 'type' => 'string', + 'required' => true, + 'example' => '29293939****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'C20209399229****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'example' => '{"id":"200292992","name":"Alibaba_catalog"}', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"无\\",\\n \\"Model\\": {\\n \\"id\\": \\"200292992\\",\\n \\"name\\": \\"Alibaba_catalog\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '获取Waba绑定的目录', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'ListProduct' => [ + 'summary' => '查询目录下的商品列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CatalogId', + 'in' => 'query', + 'schema' => [ + 'description' => '目录ID，可在Meta平台获取目录ID。', + 'type' => 'string', + 'required' => true, + 'example' => '2939838xxxx', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => '字段列表，多个字段用半角逗号（,）隔开。'."\n" + .'具体字段请参考 [商品字段](~~2579419~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'id,name', + ], + ], + [ + 'name' => 'Before', + 'in' => 'query', + 'schema' => [ + 'description' => '查询前一页消息的结束位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'wiidkd939kek93', + ], + ], + [ + 'name' => 'After', + 'in' => 'query', + 'schema' => [ + 'description' => '查询下一页消息的起始位置。', + 'type' => 'string', + 'required' => false, + 'example' => 'kdkii48jfjjei3', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '查询数量。取值范围[1,1000]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '73', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'C2939838xxxx', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '3848747xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Model' => [ + 'description' => '请求结果数据。', + 'type' => 'object', + 'properties' => [ + 'Paging' => [ + 'description' => '分页详情。', + 'type' => 'object', + 'properties' => [ + 'Cursors' => [ + 'description' => '分页位置。', + 'type' => 'object', + 'properties' => [ + 'Before' => [ + 'description' => '前一条记录位置。', + 'type' => 'string', + 'example' => 'sjjsjdjjdjd83883', + ], + 'After' => [ + 'description' => '后一条记录位置。', + 'type' => 'string', + 'example' => 'sjsuueu83838', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'array', + 'items' => [ + 'description' => '商品数据。', + 'type' => 'object', + 'example' => '{"id":"293983883", "name":"product1"}', + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Model\\": {\\n \\"Paging\\": {\\n \\"Cursors\\": {\\n \\"Before\\": \\"sjjsjdjjdjd83883\\",\\n \\"After\\": \\"sjsuueu83838\\"\\n }\\n },\\n \\"Data\\": [\\n {\\n \\"id\\": \\"293983883\\",\\n \\"name\\": \\"product1\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '商品列表', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetChatappPhoneNumberMetric' => [ + 'summary' => '查询WhatsApp类型通道号码的发送量指标。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195300', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikd****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-************', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '指标粒度。取值：'."\n" + .'- DAILY：按天统计指标。'."\n" + .'- HALF_HOUR：按每半小时统计指标。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DAILY', + ], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1756742399000', + ], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1758902399000', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商业号码。即为您发送消息的号码，在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**WABA管理**>**号码管理**界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => '861380000****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'DeliveredCount' => [ + 'description' => '到达量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Start' => [ + 'description' => '指标统计开始时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669619491000', + ], + 'PhoneNumber' => [ + 'description' => '商业号码。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'End' => [ + 'description' => '指标统计结束时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667196043904', + ], + 'Granularity' => [ + 'description' => '指标粒度。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DAILY', + ], + 'SentCount' => [ + 'description' => '发送量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[API错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": [\\n {\\n \\"DeliveredCount\\": 5,\\n \\"Start\\": 1669619491000,\\n \\"PhoneNumber\\": \\"861380000****\\",\\n \\"End\\": 1667196043904,\\n \\"Granularity\\": \\"DAILY\\",\\n \\"SentCount\\": 10\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询号码的发送量指标', + 'description' => '- 此接口只能查询WhatsApp类型通道的号码发送量统计指标。'."\n" + ."\n" + .'- 您可调用此接口查询号码发送量指标，也可在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**客户统计日报**界面查询号码发送量指标。'."\n" + ."\n\n" + .'- 在调用此接口前，请先调用[EnableWhatsAppROIMetric](~~2557789~~)接口开启WhatsApp ROI指标统计，开启后至少需一天才会有统计数据，开启前的消息发送量指标将不进行统计。'."\n" + ."\n" + .'- 开启WhatsApp ROI指标统计后，请确保您创建的通道已有成功发送的消息。您可在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**消息发送**界面发送消息，或通过[SendChatappMessage](~~432208~~)、[SendChatappMassMessage](~~447926~~)接口发送消息。'."\n" + ."\n\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'EnableWhatsappROIMetric' => [ + 'summary' => '开启Whatsapp相关指标统计。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195264', + 'abilityTreeNodes' => [ + 'FEATUREcamsX2FDGF', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikd****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-************'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[API错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '开启Whatsapp ROI指标统计', + 'description' => '- 在通过API方式获取WhatsApp类型通道的号码发送量指标，或Marketing类型模板的相关指标之前，您需要先调用此接口开启Whatsapp ROI指标统计。'."\n" + ."\n" + .'- 开启Whatsapp ROI指标统计后，至少需一天才会有指标统计数据，开启前的消息发送量指标和Marketing类型模板的相关指标将不进行统计。'."\n" + ."\n" + .'- 开启Whatsapp ROI指标统计后，您可调用[GetChatappPhoneNumberMetric](~~2557788~~)接口查询号码的发送量指标、调用[GetChatappTemplateMetric](~~2557790~~)接口查询Marketing类型模板的相关指标。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为5次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetChatappTemplateMetric' => [ + 'summary' => '获取营销类型模板的相关指标。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195220', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板Code。在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**模板设计**界面查看模板编码。', + 'type' => 'string', + 'required' => true, + 'example' => '1100***************'."\n", + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '模板语言。更多语言请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV校验码，用于校验子账号是否由ISV授权。', + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikd****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在<props="china">[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[通道管理](https://chatapp.console.alibabacloud.com/CustomerList)</props>界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-************'."\n", + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。取值：'."\n" + .'- WHATSAPP'."\n" + ."\n" + .'> 当未传递此值时，默认值为WHATSAPP。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'description' => '指标粒度。取值：'."\n" + .'- DAILY：按天统计指标。'."\n" + .'- HALF_HOUR：按每半小时统计指标。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DAILY', + ], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693107714687', + ], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693407714687', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'example' => '1100***************', + ], + 'DeliveredCount' => [ + 'description' => '到达量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Language' => [ + 'description' => '模板语言。', + 'type' => 'string', + 'example' => 'en', + ], + 'Cliented' => [ + 'description' => '按钮点击统计列表。', + 'type' => 'array', + 'items' => [ + 'description' => '按钮点击统计。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '按钮类型。取值：'."\n" + .'- phone_number_button：拨打电话按钮。'."\n" + .'- url_button：链接按钮。'."\n" + .'- quick_relpy_button：自动回复按钮。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'quick_reply_button', + ], + 'ButtonContent' => [ + 'description' => '按钮文本。', + 'type' => 'string', + 'example' => 'reply', + ], + 'Count' => [ + 'description' => '点击次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'example' => '', + ], + 'Start' => [ + 'description' => '指标统计开始时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1673919240001', + ], + 'End' => [ + 'description' => '指标统计结束时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668138331485', + ], + 'SentCount' => [ + 'description' => '发送量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReadCount' => [ + 'description' => '阅读量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[API错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": [\\n {\\n \\"TemplateCode\\": \\"1100***************\\",\\n \\"DeliveredCount\\": 6,\\n \\"Language\\": \\"en\\",\\n \\"Cliented\\": [\\n {\\n \\"Type\\": \\"quick_reply_button\\",\\n \\"ButtonContent\\": \\"reply\\",\\n \\"Count\\": 20\\n }\\n ],\\n \\"Start\\": 1673919240001,\\n \\"End\\": 1668138331485,\\n \\"SentCount\\": 10,\\n \\"ReadCount\\": 3\\n }\\n ],\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '获取营销类型模板的相关指标', + 'description' => '- 此接口只能查询WhatsApp类型通道营销模板的相关指标。'."\n" + ."\n" + .'- 在调用此接口前，请先调用[EnableWhatsAppROIMetric](~~2557789~~)接口开启WhatsApp ROI指标统计，开启后至少需一天才会有统计数据，开启前的营销模板相关指标将不进行统计。'."\n" + ."\n" + .'- 开启WhatsApp ROI指标统计后，请确保您创建的通道的营销模板已有成功发送的消息。您可在<props="china">[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)</props><props="intl">[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)</props>>**管理**>**消息发送**界面发送消息，或通过[SendChatappMessage](~~432208~~)、[SendChatappMassMessage](~~447926~~)接口发送消息。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetPreValidatePhoneId' => [ + 'summary' => '预注册号码获取ID，用来在嵌入式中选择，不用重新获取验证码。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '190716', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '号码', + 'description' => '号码。', + 'type' => 'string', + 'required' => true, + 'example' => '86138****', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '预校验号码购买时提供的验证码', + 'description' => '预校验号码购买时提供的验证码。', + 'type' => 'string', + 'required' => true, + 'example' => '2083**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'title' => '结果返回OK为正常', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '错误描述信息', + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumberId' => [ + 'title' => '号码ID', + 'description' => '号码ID。', + 'type' => 'string', + 'example' => '861380000****', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => '号码。', + 'type' => 'string', + 'example' => '92****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"PhoneNumberId\\": \\"861380000****\\",\\n \\"PhoneNumber\\": \\"92****\\"\\n }\\n}","type":"json"}]', + 'title' => '获取预校验号码的ID', + 'description' => '本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateChatFlow' => [ + 'summary' => '创建流程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '流程标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'WhatsApp自动回复', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '流程备注。', + 'type' => 'string', + 'required' => false, + 'example' => '通过API触发下发验证模板', + ], + ], + [ + 'name' => 'FlowTriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => '流程触发类型。取值：'."\n" + .' - TriggeredManually'."\n" + .'- TriggeredByWhatsApp'."\n" + .'- TriggeredByMessenger'."\n" + .'- TriggeredByInstagram'."\n" + .'- TriggeredByViber', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'TriggeredByWhatsApp', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '响应数据。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建流程', + 'description' => '- 您可通过此接口创建流程，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程。'."\n" + ."\n" + .'- 在创建流程后，您可参考[流程编辑器组件说明](~~2836818~~)进行画布编排。', + ], + 'CreateChatFlowByImport' => [ + 'summary' => '创建并导入流程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219825', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '流程标题。', + 'type' => 'string', + 'required' => false, + 'example' => 'WhatsApp触发订阅', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '流程备注。', + 'type' => 'string', + 'required' => false, + 'example' => '触发订阅', + ], + ], + [ + 'name' => 'FlowViewModel', + 'in' => 'query', + 'schema' => [ + 'description' => '导入的流程DSL数据，即为一段JSON格式的数据，您可提前在流程编辑器画布中编排好流程组件，保存后单击画布编排右上角**设置**>**导出**为一个JSON格式数据文件进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "schema": {'."\n" + .' "namespace": "External",'."\n" + .' "version": "1.0",'."\n" + .' "copyright": "Alibaba Cloud"'."\n" + .' },'."\n" + .' "editor": "H4sIAAAAAAAAA+1YbU/c***********************",'."\n" + .' "flow": {'."\n" + .' "triggerType": "TriggeredByWhatsApp"'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建并导入流程', + 'description' => '- 您可调用此接口创建并导入流程，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建并导入流程。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有导出的流程DSL数据。'."\n" + ."\n" + .'- 若您没有已导出的流程DSL数据，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面进行画布组件编排，保存后并导出为JSON格式的数据文件。', + ], + 'CreateChatFlowLogSetting' => [ + 'summary' => '创建流程日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建流程日志设置', + 'description' => '- 您在使用API方式更新流程日志设置时，首先需要创建流程日志设置，创建完成后，您可通过[ReadChatFlowLogSetting](~~2937212~~)接口查看流程日志设置信息；再通过[UpdateChatFlowLogSetting](~~2937210~~)接口更新流程日志设置。'."\n" + ."\n" + .'- 若您无需使用API的方式更新流程日志设置，可直接在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**>**日志**界面手动更新流程日志信息。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有已创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。', + ], + 'CreateFlowVersion' => [ + 'summary' => '通过复制流程版本创建新的流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216193', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'FlowVersionCopyFrom', + 'in' => 'query', + 'schema' => [ + 'description' => '需要复制的流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面查看流程历史版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '版本备注。', + 'type' => 'string', + 'required' => false, + 'example' => '修复发送WhatsApp消息错误', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '请求状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '创建流程版本', + 'description' => '- 您可调用此接口创建一个新的流程版本，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动复制一个新的流程版本。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有已创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。', + ], + 'DeleteChatFlow' => [ + 'summary' => '删除流程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '响应数据', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除流程', + 'description' => '- 您可调用此接口删除流程，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动删除流程。'."\n" + ."\n" + .'- 在删除流程之前，请确保您的流程状态为已下线。'."\n" + ."\n" + .'- 流程删除后不可恢复，请谨慎操作。', + ], + 'DeleteFlowVersion' => [ + 'summary' => '删除流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)中查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + 'example' => '434991', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": 434991,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除流程版本', + 'description' => '- 您可调用此接口删除流程版本，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动删除流程版本。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您的流程版本为已下线状态，且流程版本数量至少为两个。'."\n" + ."\n" + .'- 若您的流程版本为已上线状态，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动下线流程版本或通过[OfflineFlowVersion](~~2937198~~)接口下线流程版本。'."\n" + ."\n" + .'- 流程版本删除后，您编排的画布流程不可恢复，请谨慎操作。', + ], + 'FlowBindPhone' => [ + 'summary' => '流程绑定号码或商家账号ID。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217309', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'ChannelCode', + 'in' => 'query', + 'schema' => [ + 'description' => '消息渠道Code，即为通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看通道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8c8*********', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息渠道Type。取值：'."\n" + .'- INSTAGRAM'."\n" + .'- WHATSAPP'."\n" + .'- MESSENGER'."\n" + ."\n" + .'<props="intl">- VIBER</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通道实例下的手机号/PageId/AccountId<props="intl">/ServiceId</props>列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个手机号/PageId/AccountId</props><props="intl">/ServiceId</props>。'."\n" + ."\n\n" + .'- 当ChannelType参数为WHATSAPP时，传WhatsApp通道实例下的商家手机号码。在[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)>**管理**>**WABA管理**>**号码管理**界面查看商家手机号码。'."\n" + ."\n" + .'- 当ChannelType参数为MESSENGER时，传Messenger通道实例下的PageId（公共主页面ID）。在[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)>**管理**>**公共主页**界面查看页面ID。'."\n" + ."\n" + .'- 当ChannelType参数为INSTAGRAM时，传Instagram通道实例下的AccountId（专业账户ID）。在[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)>**管理**>**专业账户**界面查看账户ID。'."\n" + ."\n\n" + .'<props="intl">- 当ChannelType参数为VIBER时，传Viber通道实例下的ServiceId（服务号ID）。在[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)>**管理**>**服务号管理**界面查看服务号ID。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA账号ID/PageId/AccountId<props="intl">/ServiceId</props>。'."\n" + ."\n" + .'- 当ChannelType参数为WHATSAPP时，传WABA账号ID。在[**通道管理**](https://chatapp.console.aliyun.com/ChannelsManagement)>**管理**>**WABA管理**界面查看WABA账号ID。'."\n" + ."\n" + .'- 当ChannelType参数非WHATSAPP时，MESSENGER对应传PageId；INSTAGRAM对应传AccountId<props="intl">；VIBER对应传ServiceId</props>。', + 'type' => 'string', + 'required' => true, + 'example' => '1952************', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Model' => [ + 'description' => '返回结果是否成功。取值：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Model\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '流程绑定号码或商家账号ID', + 'description' => '- 您可调用此接口给流程绑定号码或商家账号ID，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面手动绑定。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您已有创建成功的流程；已有创建成功对应流程类型的消息通道。'."\n" + ."\n" + .'- WhatsApp通道类型需已完成[WABA注册及绑定](~~172335~~)、[新增号码](~~2656131~~)。'."\n" + .'- Messenger通道类型需已完成[连接公共主页账号](~~2837713~~)。'."\n" + .'- Instagram通道类型需已完成[连接专业账户账号](~~2837720~~)。'."\n" + ."\n" + .'<props="intl">- Viber通道类型需已完成[申请服务号](~~2807995~~)。</props>', + ], + 'FlowRebindPhone' => [ + 'summary' => '流程重新绑定号码或商家账号ID。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************'."\n", + ], + ], + [ + 'name' => 'ChannelCode', + 'in' => 'query', + 'schema' => [ + 'description' => '消息渠道Code，即为通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看通道ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8c8*********'."\n", + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息渠道Type。取值：'."\n" + ."\n" + .'- INSTAGRAM'."\n" + ."\n" + .'- WHATSAPP'."\n" + ."\n" + .'- MESSENGER'."\n" + ."\n" + .'<props="intl">- VIBER</props>', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通道实例下的手机号/PageId/AccountId<props="intl">/ServiceId</props>列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个手机号/PageId/AccountId<props="intl">/ServiceId</props>'."\n" + .'。'."\n" + ."\n" + .'- 当ChannelType参数为WHATSAPP时，传WhatsApp通道实例下的商家手机号码。在通道管理>管理>WABA管理>号码管理界面查看商家手机号码。'."\n" + ."\n" + .'- 当ChannelType参数为MESSENGER时，传Messenger通道实例下的PageId（公共主页面ID）。在通道管理>管理>公共主页界面查看页面ID。'."\n" + ."\n" + .'- 当ChannelType参数为INSTAGRAM时，传Instagram通道实例下的AccountId（专业账户ID）。在通道管理>管理>专业账户界面查看账户ID。'."\n" + ."\n\n" + ."\n" + .'<props="intl">- 当ChannelType参数为VIBER时，传Viber通道实例下的ServiceId（服务号ID）。在通道管理>管理>服务号管理界面查看服务号ID。</props>', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA账号ID/PageId/AccountId<props="intl">/ServiceId</props>。'."\n" + ."\n" + .'- 当ChannelType参数为WHATSAPP时，传WABA账号ID。在通道管理>管理>WABA管理界面查看WABA账号ID。'."\n" + ."\n" + .'- 当ChannelType参数非WHATSAPP时，MESSENGER对应传PageId；INSTAGRAM对应传AccountId<props="intl">；VIBER对应传ServiceId</props>。', + 'type' => 'string', + 'required' => true, + 'example' => '1952************'."\n", + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Model' => [ + 'description' => '返回结果是否成功。取值：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '流程重新绑定号码或商家账号ID', + 'description' => '- 您可调用此接口给已绑定的流程重新绑定号码或商家账号ID，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面手动重新绑定。'."\n" + ."\n" + .'- 在调用此接口前，请确保您创建的流程已绑定号码或商家账号ID。'."\n" + ."\n" + .'- 若您为首次给流程绑定号码或商家账号ID，可通过[FlowBindPhone](~~2937190~~)接口进行绑定。', + ], + 'FlowUnbindPhone' => [ + 'summary' => '流程解除绑定号码或商家账号ID。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************'."\n", + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通道实例下的手机号/PageId/AccountId<props="intl">/ServiceId</props>列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个手机号/PageId/AccountId<props="intl">/ServiceId</props>。'."\n" + ."\n" + .'- 当ChannelType参数为WHATSAPP时，传WhatsApp通道实例下的商家手机号码。在通道管理>管理>WABA管理>号码管理界面查看商家手机号码。'."\n" + ."\n" + .'- 当ChannelType参数为MESSENGER时，传Messenger通道实例下的PageId（公共主页面ID）。在通道管理>管理>公共主页界面查看页面ID。'."\n" + ."\n" + .'- 当ChannelType参数为INSTAGRAM时，传Instagram通道实例下的AccountId（专业账户ID）。在通道管理>管理>专业账户界面查看账户ID。'."\n" + ."\n" + .'<props="intl">- 当ChannelType参数为VIBER时，传Viber通道实例下的ServiceId（服务号ID）。在通道管理>管理>服务号管理界面查看服务号ID。'."\n" + .'</props>', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '消息渠道Type。取值：'."\n" + ."\n" + .'- INSTAGRAM'."\n" + ."\n" + .'- WHATSAPP'."\n" + ."\n" + .'- MESSENGER'."\n" + ."\n" + .'<props="intl">- VIBER</props>', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Model' => [ + 'description' => '返回结果是否成功。取值：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '流程解除绑定号码或商家账号ID', + 'description' => '- 在调用此接口之前，请确保您的流程为已下线状态，若您的流程为已上线状态，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动下线或通过[OfflineFlowVersion](~~2937198~~)接口下线流程。'."\n" + ."\n" + .'- 您可调用此接口给流程解绑手机号码或商家账号ID，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面手动解绑。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您创建成功的流程已绑定手机号码或商家账号ID。'."\n" + ."\n" + .'- 若您没有绑定手机号码或商家账号ID，可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面手动绑定或通过[FlowBindPhone](~~2937190~~)接口绑定。'."\n" + ."\n" + .'- 流程解绑手机号码或商家账号ID后，您的流程将无法上线。需重新绑定手机号码或商家账号ID后，才能正常上线。', + ], + 'GetChatFlowTemplate' => [ + 'summary' => '查询流程模板详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '模板ID。可通过[ListChatFlowTemplate](~~2937208~~)接口获取模板ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + ], + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询流程模板详情', + 'description' => '- 您可调用此接口查询流程模板详情，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**模板查看**界面单击模板名称查看模板详情。'."\n" + ."\n" + .'- 您在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**模板查看**界面单击模板名称查看模板详情后可直接使用模板创建流程。', + ], + 'ListBindingRelationsForFlowVersion' => [ + 'summary' => '根据流程编码查询已绑定的手机号码或商家账号ID列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '通道类型。取值：'."\n" + .'- INSTAGRAM'."\n" + .'- WHATSAPP'."\n" + .'- MESSENGER'."\n" + ."\n\n" + .'<props="intl">- VIBER</props>', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询已绑定的号码或商家账号ID列表', + 'description' => '- 您可调用此接口查询流程绑定的手机号码或商家账号ID列表，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面查看流程绑定的手机号码或商家账号ID列表。'."\n" + ."\n" + .'- 在调用此接口前，请确保您创建的流程已绑定手机号码或商家账号ID。'."\n" + ."\n" + .'- 若您创建的流程未绑定手机号码或商家账号ID，可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**界面手动绑定手机号码或商家账号ID或通过[FlowBindPhone](~~2937190~~)接口绑定手机号码或商家账号ID。', + ], + 'ListChatFlow' => [ + 'summary' => '列举流程。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216356', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '流程状态。默认值：NORMAL。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'FlowTriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => '流程触发类型。取值：'."\n" + .'- TriggeredManually'."\n" + .'- TriggeredByWhatsApp'."\n" + .'- TriggeredByInstagram'."\n" + .'- TriggeredByViber'."\n" + .'- TriggeredByMessenger', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'TriggeredByWhatsApp', + ], + ], + [ + 'name' => 'ReturnWithOnlineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回在线状态。取值：'."\n" + ."\n" + .'- true：是。'."\n" + ."\n" + .'- false：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。即为模糊查询流程名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'LLM', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '响应数据', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '列举流程', + 'description' => '- 您可调用此接口查询流程，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动查询流程。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。'."\n" + ."\n" + .'- 此接口中的非必填参数为查询流程的筛选条件，若不填写，则查询所有的流程。', + ], + 'ListChatFlowTemplate' => [ + 'summary' => '列举流程模板。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => '流程触发类型。取值：'."\n" + ."\n" + .'- TriggeredManually'."\n" + .'- TriggeredByWhatsApp'."\n" + .'- TriggeredByInstagram'."\n" + .'- TriggeredByViber'."\n" + .'- TriggeredByMessenger', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'TriggeredByWhatsApp', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。即为模糊查询模板名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'LLM', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + ], + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '列举流程模板', + 'description' => '- 您可调用此接口查看模板列表，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**模板查看**界面查看模板列表。'."\n" + ."\n" + .'- 此接口中的非必填参数为模板列表的筛选条件，若不填写，则查询所有模板列表。', + ], + 'ListChatappMessage' => [ + 'summary' => '查询消息清单。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245935', + 'abilityTreeNodes' => [ + 'FEATUREcamsU2M7I2', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '商家号码。'."\n" + ."\n" + .'- WhatsApp类型通道在[**通道管理**](https://chatapp.console.aliyun.com/CustomerList)>**管理**>**WABA管理**>**号码管理**界面查看商家号码。'."\n" + ."\n" + .'<props="intl">- Viber类型通道在[**通道管理**](https://chatapp.console.aliyun.com/CustomerList)>**管理**>**服务号管理**界面查看Service ID。</props>', + 'type' => 'string', + 'required' => true, + 'example' => '8613800****', + ], + ], + [ + 'name' => 'StartTimeStr', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-01 00:00:00', + ], + ], + [ + 'name' => 'EndTimeStr', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '2024-01-30 00:00:00', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727057232686', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。时间戳，单位：毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1727057232686', + ], + ], + [ + 'name' => 'EventAction', + 'in' => 'query', + 'schema' => [ + 'description' => '消息类型。取值：'."\n" + .'- DOWN：下行消息。'."\n" + .'- UP：上行消息。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'UP', + ], + ], + [ + 'name' => 'UserNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '用户号码。指您在[**通道管理**](https://chatapp.console.aliyun.com/CustomerList)>**管理**>**消息发送**界面发送消息时导入的用户号码。', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '类型。取值：'."\n" + ."\n" + .'- **whatsapp**。'."\n" + ."\n" + .'- **viber**。', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'ClientAcceptStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '用户接收状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。在[**通道管理**](https://chatapp.console.aliyun.com/CustomerList)>**管理**>**模板设计**界面查看模板编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9938***', + ], + ], + [ + 'name' => 'GroupMessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '批量消息ID。您可在[**通道管理**](https://chatapp.console.alibabacloud.com/CustomerList)>**管理**>**消息清单**>**批量发送清单**界面查看批量消息ID。', + 'type' => 'string', + 'required' => false, + 'example' => '9292****', + ], + ], + [ + 'name' => 'MessageStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '消息状态。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在[通道管理](https://chatapp.console.aliyun.com/CustomerList)界面查看Space ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-************', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分页参数对象。', + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + 'Index' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC', + ], + 'Data' => [ + 'description' => '返回数据对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'ConversationId' => [ + 'description' => '会话id。', + 'type' => 'string', + 'example' => '805a66**************************', + ], + 'BusinessNumber' => [ + 'description' => '商家号码。', + 'type' => 'string', + 'example' => '86183********', + ], + 'ClientAcceptStatusName' => [ + 'description' => '消息接收状态名称。', + 'type' => 'string', + 'example' => 'Success', + ], + 'Message' => [ + 'description' => '消息内容。', + 'type' => 'string', + 'example' => 'test', + ], + 'MessageTypeName' => [ + 'description' => '消息类型名称。', + 'type' => 'string', + 'example' => 'interactive', + ], + 'FailReason' => [ + 'description' => '发送失败原因。', + 'type' => 'string', + 'example' => 'timeout', + ], + 'EventActionName' => [ + 'description' => '上行、下行消息名称。取值：'."\n" + ."\n" + .'- DOWN：下行消息。'."\n" + ."\n" + .'- UP：上行消息。', + 'type' => 'string', + 'example' => 'DOWN', + ], + 'Month' => [ + 'description' => '消息月份。', + 'type' => 'string', + 'example' => '202507', + ], + 'LanguageCode' => [ + 'description' => '模板语言。更多语言请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'example' => 'en', + ], + 'TemplateName' => [ + 'description' => '模板名称。', + 'type' => 'string', + 'example' => 'picture_template', + ], + 'MessageType' => [ + 'description' => '消息类型。', + 'type' => 'string', + 'example' => 'INTERACTIVE', + ], + 'SendTime' => [ + 'description' => '发送时间。', + 'type' => 'string', + 'example' => '2025-07-11T01:16:49.761+00:00', + ], + 'MessageStatusName' => [ + 'description' => '消息状态名称。', + 'type' => 'string', + 'example' => 'Success', + ], + 'ClientReadStatus' => [ + 'description' => '消息阅读状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'MessageSource' => [ + 'description' => '消息来源。', + 'type' => 'string', + 'example' => 'api', + ], + 'FailBackFlag' => [ + 'description' => '是否回落短信。取值：'."\n" + ."\n" + .'- Y：是。'."\n" + ."\n" + .'- N：否。', + 'type' => 'string', + 'example' => 'Y', + ], + 'UserNumber' => [ + 'description' => '用户号码。', + 'type' => 'string', + 'example' => '86177********', + ], + 'TemplateCode' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'example' => '1103***************', + ], + 'MessageStatus' => [ + 'description' => '消息状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'Type' => [ + 'description' => '类型。', + 'type' => 'string', + 'example' => 'message', + ], + 'FailBackContent' => [ + 'description' => '回落内容。', + 'type' => 'string', + 'example' => 'None', + ], + 'EventAction' => [ + 'description' => '消息上行、下行类型。', + 'type' => 'string', + 'example' => 'DOWN', + ], + 'ClientReadStatusName' => [ + 'description' => '消息阅读状态名称。', + 'type' => 'string', + 'example' => 'Success', + ], + 'UniqueMessageId' => [ + 'description' => '消息唯一ID。', + 'type' => 'string', + 'example' => '20250911******************************', + ], + 'ChannelType' => [ + 'description' => '通道类型。', + 'type' => 'string', + 'example' => 'WHATSAPP', + ], + 'MessageId' => [ + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '202509*******************', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\\",\\n \\"Data\\": [\\n {\\n \\"ConversationId\\": \\"805a66**************************\\",\\n \\"BusinessNumber\\": \\"86183********\\",\\n \\"ClientAcceptStatusName\\": \\"Success\\",\\n \\"Message\\": \\"test\\",\\n \\"MessageTypeName\\": \\"interactive\\",\\n \\"FailReason\\": \\"timeout\\",\\n \\"EventActionName\\": \\"DOWN\\",\\n \\"Month\\": \\"202507\\",\\n \\"LanguageCode\\": \\"en\\",\\n \\"TemplateName\\": \\"picture_template\\",\\n \\"MessageType\\": \\"INTERACTIVE\\",\\n \\"SendTime\\": \\"2025-07-11T01:16:49.761+00:00\\",\\n \\"MessageStatusName\\": \\"Success\\",\\n \\"ClientReadStatus\\": \\"success\\",\\n \\"MessageSource\\": \\"api\\",\\n \\"FailBackFlag\\": \\"Y\\",\\n \\"UserNumber\\": \\"86177********\\",\\n \\"TemplateCode\\": \\"1103***************\\",\\n \\"MessageStatus\\": \\"success\\",\\n \\"Type\\": \\"message\\",\\n \\"FailBackContent\\": \\"None\\",\\n \\"EventAction\\": \\"DOWN\\",\\n \\"ClientReadStatusName\\": \\"Success\\",\\n \\"UniqueMessageId\\": \\"20250911******************************\\",\\n \\"ChannelType\\": \\"WHATSAPP\\",\\n \\"MessageId\\": \\"202509*******************\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询消息清单', + 'description' => '- 您可调用此接口查询消息清单，也可在[**通道管理**](https://chatapp.console.aliyun.com/CustomerList)>**管理**>**消息清单**界面进行查看。'."\n" + ."\n" + .'- 该API仅支持查询WhatsApp<props="intl">、Viber</props>类型的通道消息清单。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已创建WhatsApp<props="intl">或Viber</props>类型通道；已绑定号码或商家账号 ID；已创建模板且完成审核；已使用通道发送消息。', + ], + 'ListFlowNodePrototypeV2' => [ + 'summary' => '列举流程组件原型。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254867', + 'abilityTreeNodes' => [ + 'FEATUREcams9OUKUU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'GroupCode', + 'in' => 'query', + 'schema' => [ + 'description' => '组件分组Code。取值：'."\n" + ."\n" + .'- Messaging：消息类组件。'."\n" + ."\n" + .'- Core：核心组件。'."\n" + ."\n" + .'- Intelligence：智能组件。'."\n" + ."\n" + .'- Contact：联系人管理组件。', + 'type' => 'string', + 'required' => false, + 'example' => 'Core', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。即为根据流程组件名称模糊查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'WhatsApp', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => '请求结果数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '请求结果数据。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '组件原型状态。默认：NORMAL（正常的）。', + 'type' => 'string', + 'example' => 'NORMAL', + ], + 'GroupCode' => [ + 'description' => '组件分组Code。', + 'type' => 'string', + 'example' => 'Core', + ], + 'PublicExtend' => [ + 'description' => '公共扩展信息。用于前端展示流程组件的拓展信息，为一段JSON STRING格式的字符串，字符串首个参数代表流程组件标题，其余字段说明：'."\n" + ."\n" + .'- en：流程组件英文信息。'."\n" + ."\n" + .'- zh：流程组件中文信息。'."\n" + ."\n" + .'- name：流程组件名称。'."\n" + ."\n" + .'- remark：流程组件备注。'."\n" + ."\n" + .'- order：流程组件展示顺序。'."\n" + ."\n" + .'- style：流程组件样式。'."\n" + ."\n" + .'- svg：流程组件图标地址。'."\n" + ."\n" + .'- icon：废弃字段。'."\n" + ."\n" + .'- bgcolor：图标底色。', + 'type' => 'string', + 'example' => '{\\"i18n\\": {\\"en\\": {\\"name\\": \\"Send a WhatsApp Message\\", \\"remark\\": \\"Send a message with the ability for the user to reply utilizing WhatsApp specific features.\\"}, \\"zh\\": {\\"name\\": \\"Send WhatsApp messages\\", \\"remark\\": \\"Send a message that allows users to reply using specific features of WhatsApp\\"}}, \\"order\\": \\"9000\\", \\"style\\": {\\"svg\\": \\"https://img.alicdn.com/***********************************\\", \\"icon\\": \\"https://img.alicdn.com/***********************************\\", \\"bgcolor\\": \\"blue\\"}}', + ], + 'Code' => [ + 'description' => '组件原型Code。', + 'type' => 'string', + 'example' => 'SendWhatsAppMessageNode', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Data\\": {\\n \\"Model\\": [\\n {\\n \\"Status\\": \\"NORMAL\\",\\n \\"GroupCode\\": \\"Core\\",\\n \\"PublicExtend\\": \\"{\\\\\\\\\\\\\\"i18n\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"en\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Send a WhatsApp Message\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Send a message with the ability for the user to reply utilizing WhatsApp specific features.\\\\\\\\\\\\\\"}, \\\\\\\\\\\\\\"zh\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Send WhatsApp messages\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"remark\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Send a message that allows users to reply using specific features of WhatsApp\\\\\\\\\\\\\\"}}, \\\\\\\\\\\\\\"order\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"9000\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"style\\\\\\\\\\\\\\": {\\\\\\\\\\\\\\"svg\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"https://img.alicdn.com/***********************************\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"icon\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"https://img.alicdn.com/***********************************\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"bgcolor\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"blue\\\\\\\\\\\\\\"}}\\",\\n \\"Code\\": \\"SendWhatsAppMessageNode\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '列举流程组件原型', + 'description' => '- 您可调用此接口查询流程组件原型，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面查看流程组件原型。'."\n" + ."\n" + .'- 此接口中的非必填参数为流程组件原型的筛选条件，若不填写，则查询全部的流程组件原型。', + ], + 'ListFlowVersion' => [ + 'summary' => '列举流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216205', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查询流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本状态。取值：'."\n" + .'- DRAFT：草稿。'."\n" + .'- DELETED：已删除。'."\n" + .'- ONLINE：上线。'."\n" + .'- OFFLINE：下线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DRAFT', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '列举流程版本', + 'description' => '- 您可调用此接口查询流程版本，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面查看流程版本。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。'."\n" + ."\n" + .'- 此接口中的非必填参数为查询流程版本的筛选条件，若不填写，则查询全部流程版本。', + ], + 'OfflineFlowVersion' => [ + 'summary' => '下线的流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************'."\n", + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本，在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '流程备注，在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程备注。', + 'type' => 'string', + 'required' => false, + 'example' => '不再需要此版本', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认值：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：表示成功。'."\n" + ."\n" + .'- false：表示失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '下线流程版本', + 'description' => '- 你可调用此接口下线流程版本，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动下线流程版本。'."\n" + ."\n" + .'- 在调用此接口之前，请确保您创建的流程已上线。'."\n" + ."\n" + .'- 若您创建的流程未上线，可以在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动上线流程版本或通过[OnlineFlowVersion](~~2937203~~)接口上线流程版本。'."\n" + ."\n" + .'- 流程版本下线后，您所编排的流程将终止运行，这可能会影响您的业务，请谨慎操作。', + ], + 'OnlineFlowVersion' => [ + 'summary' => '上线流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '流程备注。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程备注。', + 'type' => 'string', + 'required' => false, + 'example' => '通过API触发下发验证模板', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '上线流程版本', + 'description' => '- 您可调用此接口上线流程版本。也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动上线流程版本。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程且您的流程已绑定手机号码或商家账号ID。'."\n" + ."\n" + .'- 若您没有已创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程并绑定手机号码或商家账号ID或通过[CreateChatFlow](~~2937204~~)、[FlowBindPhone](~~2937190~~)接口创建流程并绑定手机号码或商家账号ID。'."\n" + ."\n" + .'- 触发器类型非手动的流程在上线后，绑定的手机号码或商家账号在给商家发送消息以后就会触发流程，若您的流程含有消息发送、函数调用等产生对应云产品费用的组件，请确保在使用该接口前，已充分了解相关产品的收费方式和价格。', + ], + 'ReadChatFlow' => [ + 'summary' => '获取流程详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取流程详情', + 'description' => '- 您可调用此接口获取流程详情，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动查看流程详情。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。', + ], + 'ReadChatFlowLogSetting' => [ + 'summary' => '查看流程日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查看流程日志设置', + 'description' => '- 在调用此接口前，请确保您的流程已创建流程日志设置。'."\n" + ."\n" + .'- 若您的流程未创建流程日志设置，请先通过[CreateChatFlowLogSetting](~~2937211~~)接口创建流程日志设置。'."\n" + ."\n" + .'- 您可通过此接口返回设置的唯一ID，调用[UpdateChatFlowLogSetting](~~2937210~~)接口更新流程日志设置。', + ], + 'ReadFlowVersion' => [ + 'summary' => '获取流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面查看流程版本或通过[ListFlowVersion](~~2937202~~)获取流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本状态。取值：'."\n" + .'- DRAFT：草稿。'."\n" + .'- DELETED：已删除。'."\n" + .'- ONLINE：在线。'."\n" + .'- OFFLINE：下线。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DRAFT', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取流程版本', + 'description' => '- 您可调用此接口查询流程版本，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面查看流程版本。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已成功创建流程。'."\n" + ."\n" + .'- 若您没有创建成功的流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)创建流程。', + ], + 'UpdateChatFlow' => [ + 'summary' => '根据流程编码更新流程基础信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '216353', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '更新后的流程名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试流程', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '更新后的流程备注。', + 'type' => 'string', + 'required' => false, + 'example' => '流程备注', + ], + ], + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************'."\n", + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认值：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新流程基础信息', + 'description' => '- 你可调用此接口更新流程基础信息，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**>**基础信息**界面手动更新。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已有创建成功的流程。'."\n" + ."\n" + .'- 若您没有已创建成功的流程，可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击**创建流程**手动创建。', + ], + 'UpdateChatFlowLogSetting' => [ + 'summary' => '更新流程日志设置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '设置的唯一ID，该参数通过[ReadChatFlowLogSetting](~~2937212~~)接口获取设置的唯一ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '日志启用状态。取值：'."\n" + .'- ENABLED：启用日志写入。'."\n" + ."\n" + .'- DISABLED：不启用日志写入，保留SLS日志实例。'."\n" + ."\n" + .'- DELETED：不启用日志写入，删除SLS日志实例。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ENABLED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新流程日志设置', + 'description' => '- 您可调用此接口更新流程日志设置，也可在[**流程编辑器**](https://chatapp.console.aliyun.com/ChatFlowBuilder)>**设置**>**日志**界面手动更新流程日志设置。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已开通[日志服务](https://sls.console.aliyun.com/lognext/open)；已创建流程日志设置。'."\n" + ."\n" + .'- 若您未给流程创建流程日志设置，请先通过[CreateChatFlowLogSetting](~~2937211~~)接口创建流程日志设置。'."\n" + ."\n" + .'- 流程日志设置更新后，可能会对您的业务造成影响，请谨慎操作。', + ], + 'UpdateContactById' => [ + 'summary' => '修改联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '创建的联系人ID', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'ContactDetails', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人描述', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => '国家代码。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务编码。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + 'default' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Data\\": \\"示例值\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新联系人信息', + ], + 'UpdateFlowVersion' => [ + 'summary' => '更新流程版本DSL数据，用于画布更新流程版本。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FlowViewModel', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本的DSL数据。即为一段JSON格式的数据，您可提前在流程编辑器画布中编排好流程组件，保存后单击画布编排右上角**设置**>**导出**为一个JSON格式数据文件进行查看。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "schema": {'."\n" + .' "namespace": "External",'."\n" + .' "version": "1.0",'."\n" + .' "copyright": "Alibaba Cloud"'."\n" + .' },'."\n" + .' "editor": "H4sIAAAAAAAAA+1YbU/c***********************",'."\n" + .' "flow": {'."\n" + .' "triggerType": "TriggeredByWhatsApp"'."\n" + .' }'."\n" + .'}', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '版本备注。', + 'type' => 'string', + 'required' => false, + 'example' => '修复发送WhatsApp消息错误', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => '返回数据的内容。', + 'type' => 'object', + 'example' => '436489', + ], + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Response\\": 436489,\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '更新流程版本DSL数据', + 'description' => '- 您可调用此接口更新流程版本DSL数据，也可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排页面更新流程版本DSL数据。'."\n" + ."\n" + .'- 在调用此接口前，请确保您已创建流程且流程状态为已下线。'."\n" + ."\n" + .'- 若您没有创建流程，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面手动创建流程或通过[CreateChatFlow](~~2937204~~)接口创建流程。', + ], + 'GetChatappPhoneNumberSetting' => [ + 'summary' => '获取Chatapp号码其它控制', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '209199', + 'abilityTreeNodes' => [ + 'FEATUREcamsDJ746K', + ], + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'C29393993****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '电话号码', + 'type' => 'string', + 'required' => true, + 'example' => '86138***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '42602478-F7C1-58D2-AFFE-88F7A18***6', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'description' => '电话号码', + 'type' => 'string', + 'example' => '86138****', + ], + 'MarketingPaused' => [ + 'description' => '是否暂停', + 'type' => 'string', + 'example' => 'Y', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '表示是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"42602478-F7C1-58D2-AFFE-88F7A18***6\\",\\n \\"Model\\": {\\n \\"PhoneNumber\\": \\"86138****\\",\\n \\"MarketingPaused\\": \\"Y\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取Chatapp号码配置', + ], + 'AddAddressRecoverSuspend' => [ + 'summary' => '申请：变更目的地/恢复/暂停', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestType', + 'in' => 'query', + 'schema' => [ + 'description' => '请求类型', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '客户SpaceId', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AuditRecord', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '审核记录', + 'type' => 'object', + 'properties' => [ + 'RecoveryDate' => [ + 'description' => '恢复日期', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '消息目的地国际国家列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息目的地国际国家', + 'type' => 'string', + 'required' => false, + 'example' => 'Country', + ], + 'required' => false, + 'example' => '', + ], + 'MessageDestinationCountry' => [ + 'description' => '消息目的地国家列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息目的地国家', + 'type' => 'string', + 'required' => false, + 'example' => 'Country', + ], + 'required' => false, + 'example' => '', + ], + 'ApplyReason' => [ + 'description' => '申请理由。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + 'SuspensionDate' => [ + 'description' => '暂停日期', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '操作是否成功。true表示成功，false表示失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '变更目的地/恢复/暂停', + ], + 'AddAuditViberOpen' => [ + 'summary' => '注册viber账号，开户', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219910', + 'abilityTreeNodes' => [ + 'FEATUREcamsCCB2BU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AuditResult', + 'in' => 'query', + 'schema' => [ + 'description' => '审核结果。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AuditRecord', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '审核记录', + 'type' => 'object', + 'properties' => [ + 'ContactMail' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'CompanyLegalName' => [ + 'description' => '公司法定名称', + 'type' => 'string', + 'required' => false, + 'example' => 'abc公司', + ], + 'LetterGuarantee' => [ + 'description' => '保函', + 'type' => 'string', + 'required' => false, + 'example' => 'tiCaYNHR8ttt', + ], + 'IndustryInvolved' => [ + 'description' => '涉及行业', + 'type' => 'string', + 'required' => false, + 'example' => 'NFUwytiBnm11', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '信息目的地国际国家列表', + 'type' => 'array', + 'items' => [ + 'description' => '具体值', + 'type' => 'string', + 'required' => false, + 'example' => 'MessageDestinationInternationalCountry', + ], + 'required' => false, + 'example' => '', + ], + 'CompleteAddressOfHeadquarters' => [ + 'description' => '总部地址', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + 'MessageEnableDate' => [ + 'description' => '消息启用日期', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'BusinessLicenseRegistrationNumber' => [ + 'description' => '营业执照注册号', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'CompanyLegalPerson' => [ + 'description' => '公司法人', + 'type' => 'string', + 'required' => false, + 'example' => 'jerry', + ], + 'CompanyAddress' => [ + 'description' => '公司地址列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'string', + 'required' => false, + 'example' => 'address', + ], + 'CompanyAddressTitle' => [ + 'description' => '公司地址标题', + 'type' => 'string', + 'required' => false, + 'example' => 'title', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + 'CompanyRegisteredCountry' => [ + 'description' => '公司注册国家', + 'type' => 'string', + 'required' => false, + 'example' => 'cn', + ], + 'AgeLimit' => [ + 'description' => '年龄限制', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'IndustryDescription' => [ + 'description' => '行业描述', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'WebAddress' => [ + 'description' => '网址', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'EnableAutoReply' => [ + 'description' => '启用自动回复', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + 'BusinessAccountName' => [ + 'description' => '企业账户名称', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + 'Logo' => [ + 'description' => 'Logo列表', + 'type' => 'array', + 'items' => [ + 'description' => 'Logo', + 'type' => 'string', + 'required' => false, + 'example' => 'logo1', + ], + 'required' => false, + 'example' => '', + ], + 'ReplyContent' => [ + 'description' => '回复内容', + 'type' => 'string', + 'required' => false, + 'example' => 'hello', + ], + 'CompanyProfile' => [ + 'description' => '公司简介', + 'type' => 'string', + 'required' => false, + 'example' => 'CompanyProfile', + ], + 'CompanyTel' => [ + 'description' => '公司电话对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '单个对象', + 'type' => 'object', + 'properties' => [ + 'CompanyTelNumber' => [ + 'description' => '公司电话号码', + 'type' => 'string', + 'required' => false, + 'example' => '156********', + ], + 'CompanyTelTitle' => [ + 'description' => '公司电话标题', + 'type' => 'string', + 'required' => false, + 'example' => 'title', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + 'MessageDialogueIntroduction' => [ + 'description' => '消息对话框简介', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + 'OtherLetterGuarantee' => [ + 'description' => '其他信函保证', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'MessageDestinationCountry' => [ + 'description' => '消息目的地国家列表', + 'type' => 'array', + 'items' => [ + 'description' => '消息目的地国家', + 'type' => 'string', + 'required' => false, + 'example' => 'nPHK8uaRo', + ], + 'required' => false, + 'example' => '', + ], + 'MessageSessionName' => [ + 'description' => '消息会话名称', + 'type' => 'string', + 'required' => false, + 'example' => 'nPHK8uaRo', + ], + 'CompanyEnglishName' => [ + 'description' => '公司英文名称', + 'type' => 'string', + 'required' => false, + 'example' => '7Pj6', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2121-112', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'example' => '122', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"2121-112\\",\\n \\"Data\\": 122,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '注册viber账号，开户', + ], + 'AddContacts' => [ + 'summary' => '编辑联系人-新增联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'required' => false, + 'example' => 'mary', + ], + ], + [ + 'name' => 'ContactDetails', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人描述', + 'type' => 'string', + 'required' => false, + 'example' => '15111111111', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => '国家', + 'type' => 'string', + 'required' => false, + 'example' => 'China', + ], + ], + [ + 'name' => 'NeedUpdate', + 'in' => 'query', + 'schema' => [ + 'description' => '回源IP白名单是否需要更新，当所使用的回源IP白名单和最新的回源IP白名单有差异时，就需要更新，此值返回true。'."\n" + ."\n" + .'- true：需要更新。'."\n" + .'- false：不需要更新。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'Groups', + 'in' => 'query', + 'schema' => [ + 'description' => '用户组信息。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务编码。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + 'default' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '新增联系人', + ], + 'AddGroup' => [ + 'summary' => '添加群组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '分组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testgroup', + 'default' => '', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'required' => false, + 'example' => 'mary', + ], + ], + [ + 'name' => 'ContactDetails', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人描述', + 'type' => 'string', + 'required' => false, + 'example' => '15111111111', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => '国家', + 'type' => 'string', + 'required' => false, + 'example' => 'China', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'src/main/resources/config/promql_node.yaml', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + 'default' => '', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '邮箱', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '备注信息', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '无权限信息', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '提示信息，当返回异常时有值。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'dgdf5-bvcv**', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"true\\",\\n \\"RequestId\\": \\"dgdf5-bvcv**\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '添加群组', + ], + 'AddMarketingFlow' => [ + 'summary' => '新增营销活动', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221796', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActivityName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点任务实例名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'ActivityDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '活动描述', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'ExecutionType', + 'in' => 'query', + 'schema' => [ + 'description' => '基线扫描的触发方式。取值：'."\n" + ."\n" + .'- **Schedule**：周期性配置任务触发'."\n" + .'- **Manual**：手动触发', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => 'Cron表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'RelatedGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '相关组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '43', + ], + ], + [ + 'name' => 'RelatedFlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '关联流程编码', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'RelatedFlowName', + 'in' => 'query', + 'schema' => [ + 'description' => '关联流程名称', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '接口参数', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'ParamFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '参数标志', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务编码。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '新增营销活动流程', + ], + 'BindInstagramPage' => [ + 'summary' => '绑定ins的page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ins的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '14711522522', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例对应的地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + 'default' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'fdsfdsf-22fk***', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '当前页。', + 'type' => 'string', + 'example' => '1234322333', + ], + 'AccountId' => [ + 'description' => '账号ID', + 'type' => 'string', + 'example' => '13243543543', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'iwhalecloud', + ], + 'ConnectionStatus' => [ + 'description' => '连接状态', + 'type' => 'string', + 'example' => 'connected', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => 'ok', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"fdsfdsf-22fk***\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"1234322333\\",\\n \\"AccountId\\": \\"13243543543\\",\\n \\"PageName\\": \\"iwhalecloud\\",\\n \\"ConnectionStatus\\": \\"connected\\"\\n }\\n ],\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '绑定ins的page', + ], + 'BindMessengerPage' => [ + 'summary' => '绑定选择的pageId', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '181916005005216', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ap-southeast-1', + 'default' => 'ap-southeast-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'DSFDS-8FSDFS**', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '当前页码。', + 'type' => 'string', + 'example' => '1654543543543', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'iwhalecloud', + ], + 'ConnectionStatus' => [ + 'description' => '连接状态', + 'type' => 'string', + 'example' => 'CONNECTED', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码', + 'type' => 'string', + 'example' => 'ok', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"DSFDS-8FSDFS**\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"1654543543543\\",\\n \\"PageName\\": \\"iwhalecloud\\",\\n \\"ConnectionStatus\\": \\"CONNECTED\\"\\n }\\n ],\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '绑定Messenger的Page', + ], + 'CopyTemplate' => [ + 'summary' => '复制模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SceneTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板Code', + 'type' => 'string', + 'required' => true, + 'example' => '12456', + ], + ], + [ + 'name' => 'SceneTemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '语言。', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'SceneTemplateCode' => [ + 'description' => '模板Code', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'WhatsappCatagory' => [ + 'description' => 'Whatsapp类别', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'SceneTemplateName' => [ + 'description' => '模板名称', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '状态码', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Data\\": {\\n \\"SceneTemplateCode\\": \\"示例值示例值\\",\\n \\"WhatsappCatagory\\": \\"示例值示例值\\",\\n \\"SceneTemplateName\\": \\"示例值示例值示例值\\"\\n },\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '复制模板', + ], + 'CreateWhatsappConversionApi' => [ + 'summary' => '根据嵌入式code获取pageId入库', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => '131', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '嵌入式code', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '嵌入式permissions列表', + 'type' => 'array', + 'items' => [ + 'description' => '嵌入式permissions', + 'type' => 'string', + 'required' => false, + 'example' => 'User', + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '根据嵌入式code获取pageId入库', + ], + 'DeleteContacts' => [ + 'summary' => '编辑联系人-删除联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => '文件路径。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://****', + ], + ], + [ + 'name' => 'ContactDetails', + 'in' => 'query', + 'schema' => [ + 'description' => '联系方式', + 'type' => 'string', + 'required' => false, + 'example' => '1507486****', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'required' => false, + 'example' => 'hahaha', + ], + ], + [ + 'name' => 'Country', + 'in' => 'query', + 'schema' => [ + 'description' => '国家。', + 'type' => 'string', + 'required' => false, + 'example' => 'China', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务编码。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '权限校验失败详情。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '11111', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"11111\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除联系人', + ], + 'DeleteContactsByIds' => [ + 'summary' => '删除联系人(选择后删除)', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Contacts', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人Code列表，用,分隔', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '批量删除联系人', + ], + 'DeleteGroupById' => [ + 'summary' => '删除群组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '112', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1223-1111', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"1223-1111\\",\\n \\"Data\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除群组', + ], + 'DeleteInstagramPage' => [ + 'summary' => '删除ins的page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '154654654654654', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '响应信息', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '请求的ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'gfdg435t-hf544**', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"gfdg435t-hf544**\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '删除ins的page', + ], + 'DeleteMarketingFlow' => [ + 'summary' => '删除营销活动', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221795', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActivityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '活动编码,可使用系统编码，也可修改系统编码使用自定义编码', + 'type' => 'string', + 'required' => false, + 'example' => '1111', + ], + ], + [ + 'name' => 'ActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID(已弃用)', + 'type' => 'string', + 'required' => false, + 'example' => '已弃用', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '删除营销活动', + ], + 'DeleteMessengerPage' => [ + 'summary' => '删除messenger的page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '154332432432', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'e01-in-71cc15xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'JHGJG-65HFGF**', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"JHGJG-65HFGF**\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '删除messenger的公共主页', + ], + 'GeneratePresignedUrl' => [ + 'summary' => '获取临时的URL', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'description' => 'OSS路径', + 'type' => 'string', + 'required' => true, + 'example' => '/aaa/111/aa.png', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '附加消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866**', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '素材路径。'."\n" + ."\n" + .'> Viber类型时图片建议大小：800 * 800。', + 'type' => 'string', + 'example' => 'https://public-oss.es**/camera_609.png', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866**\\",\\n \\"Data\\": {\\n \\"Url\\": \\"https://public-oss.es**/camera_609.png\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '获取临时的URL', + ], + 'GetAuditRequestByTypeUnAudit' => [ + 'summary' => '通过类型查询出个人待审核的单子', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestType', + 'in' => 'query', + 'schema' => [ + 'description' => '请求类型', + 'type' => 'string', + 'required' => true, + 'example' => 'viberOpen', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。在[通道管理](https://chatapp.console.aliyun.com/CustomerList)界面查看Space ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486***', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'AuditResult' => [ + 'description' => '审核结果。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Creator' => [ + 'description' => '创建人。', + 'type' => 'string', + 'example' => '11', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1789200', + ], + 'SubscriberCode' => [ + 'description' => '订户编码', + 'type' => 'string', + 'example' => '345436456546', + ], + 'MaapServiceNo' => [ + 'description' => 'Viber服务号', + 'type' => 'string', + 'example' => '475646', + ], + 'State' => [ + 'description' => '任务状态。', + 'type' => 'string', + 'example' => 'A', + ], + 'AuditTime' => [ + 'description' => '审核时间', + 'type' => 'string', + 'example' => '20250106', + ], + 'GmtModifier' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '20251624', + ], + 'AuditRecord' => [ + 'description' => '审核数据', + 'type' => 'object', + 'properties' => [ + 'ContactMail' => [ + 'description' => '公司邮箱', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'CompanyLegalName' => [ + 'description' => '公司法定名称', + 'type' => 'string', + 'example' => 'xxxxcompany', + ], + 'LetterGuarantee' => [ + 'description' => '保证函地址', + 'type' => 'string', + 'example' => 'https://www.xxxxxxx', + ], + 'IndustryInvolved' => [ + 'description' => '所属行业', + 'type' => 'string', + 'example' => 'it', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '国际目的地国家或地区', + 'type' => 'array', + 'items' => [ + 'description' => '列表', + 'type' => 'string', + 'example' => '["12|es"]', + ], + 'example' => '', + ], + 'MessageEnableDate' => [ + 'description' => '商业消息启用日期', + 'type' => 'string', + 'example' => '2025-11-01', + ], + 'CompanyLegalPerson' => [ + 'description' => '公司法人名称', + 'type' => 'string', + 'example' => 'jack', + ], + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'array', + 'items' => [ + 'description' => '集合', + 'type' => 'object', + 'properties' => [ + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'string', + 'example' => 'xxxxcompany', + ], + 'CompanyAddressTitle' => [ + 'description' => '地址标题', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + 'example' => '', + ], + 'CompanyRegisteredCountry' => [ + 'description' => '公司注册地国家', + 'type' => 'array', + 'items' => [ + 'description' => '集合', + 'type' => 'string', + 'example' => '[zh]', + ], + 'example' => '', + ], + 'AgeLimit' => [ + 'description' => '年龄限制', + 'type' => 'string', + 'example' => 'eighteenUp', + ], + 'IndustryDescription' => [ + 'description' => '行业简介', + 'type' => 'string', + 'example' => 'xxx', + ], + 'WebAddress' => [ + 'description' => '公司网址', + 'type' => 'string', + 'example' => 'www.xxxxx', + ], + 'EnableAutoReply' => [ + 'description' => '是否自动回复', + 'type' => 'string', + 'example' => 'N', + ], + 'NowRecovery' => [ + 'description' => '暂停', + 'type' => 'string', + 'example' => 'n', + ], + 'RecoveryDate' => [ + 'description' => '恢复日期', + 'type' => 'string', + 'example' => '2025-111-06', + ], + 'BusinessAccountName' => [ + 'description' => '商业账号名称', + 'type' => 'string', + 'example' => 'aaa', + ], + 'ApplyReason' => [ + 'description' => '申请理由。', + 'type' => 'string', + 'example' => 'bnv', + ], + 'Logo' => [ + 'description' => 'logo地址合集', + 'type' => 'array', + 'items' => [ + 'description' => 'logo集合。', + 'type' => 'string', + 'example' => '[]', + ], + 'example' => '', + ], + 'ReplyContent' => [ + 'description' => '回复内容', + 'type' => 'string', + 'example' => 'aaaqq', + ], + 'CompanyProfile' => [ + 'description' => '公司简介', + 'type' => 'string', + 'example' => 'CompanyProfile', + ], + 'MessageDialogueIntroduction' => [ + 'description' => '商业消息简介', + 'type' => 'string', + 'example' => 'MessageDialogueIntroduction ', + ], + 'CompanyTel' => [ + 'description' => '公司电话', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'CompanyTelNumber' => [ + 'description' => '公司电话', + 'type' => 'string', + 'example' => '143243**', + ], + 'CompanyTelTitle' => [ + 'description' => '公司电话标题', + 'type' => 'string', + 'example' => 'example', + ], + ], + ], + 'example' => '', + ], + 'MessageDestinationCountry' => [ + 'description' => '本地目的地国家或地区', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'string', + 'example' => '["61|es]', + ], + 'example' => '', + ], + 'MessageSessionName' => [ + 'description' => '商业消息对话名称', + 'type' => 'string', + 'example' => 'Message Session Name', + ], + 'SuspensionDate' => [ + 'description' => 'SuspensionDate', + 'type' => 'string', + 'example' => 'SuspensionDate', + ], + 'CompanyEnglishName' => [ + 'description' => '公司英文名', + 'type' => 'string', + 'example' => 'Company English Name', + ], + ], + 'example' => '', + ], + 'Id' => [ + 'description' => 'ID', + 'type' => 'string', + 'example' => 'id', + ], + 'Modifier' => [ + 'description' => '修改人', + 'type' => 'string', + 'example' => '1', + ], + 'RequestNo' => [ + 'description' => '请求号', + 'type' => 'string', + 'example' => '45345435435', + ], + 'RequestType' => [ + 'description' => '请求类型', + 'type' => 'string', + 'example' => 'viber_open', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '21432', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486***\\",\\n \\"Data\\": {\\n \\"AuditResult\\": \\"pass\\",\\n \\"Creator\\": \\"11\\",\\n \\"GmtCreate\\": \\"1789200\\",\\n \\"SubscriberCode\\": \\"345436456546\\",\\n \\"MaapServiceNo\\": \\"475646\\",\\n \\"State\\": \\"A\\",\\n \\"AuditTime\\": \\"20250106\\",\\n \\"GmtModifier\\": \\"20251624\\",\\n \\"AuditRecord\\": {\\n \\"ContactMail\\": \\"[email protected]\\",\\n \\"CompanyLegalName\\": \\"xxxxcompany\\",\\n \\"LetterGuarantee\\": \\"https://www.xxxxxxx\\",\\n \\"IndustryInvolved\\": \\"it\\",\\n \\"MessageDestinationInternationalCountry\\": [\\n \\"[\\\\\\"12|es\\\\\\"]\\"\\n ],\\n \\"MessageEnableDate\\": \\"2025-11-01\\",\\n \\"CompanyLegalPerson\\": \\"jack\\",\\n \\"CompanyAddress\\": [\\n {\\n \\"CompanyAddress\\": \\"xxxxcompany\\",\\n \\"CompanyAddressTitle\\": \\"111\\"\\n }\\n ],\\n \\"CompanyRegisteredCountry\\": [\\n \\"[zh]\\"\\n ],\\n \\"AgeLimit\\": \\"eighteenUp\\",\\n \\"IndustryDescription\\": \\"xxx\\",\\n \\"WebAddress\\": \\"www.xxxxx\\",\\n \\"EnableAutoReply\\": \\"N\\",\\n \\"NowRecovery\\": \\"n\\",\\n \\"RecoveryDate\\": \\"2025-111-06\\",\\n \\"BusinessAccountName\\": \\"aaa\\",\\n \\"ApplyReason\\": \\"bnv\\",\\n \\"Logo\\": [\\n \\"[]\\"\\n ],\\n \\"ReplyContent\\": \\"aaaqq\\",\\n \\"CompanyProfile\\": \\"CompanyProfile\\",\\n \\"MessageDialogueIntroduction\\": \\"MessageDialogueIntroduction\\\\t\\",\\n \\"CompanyTel\\": [\\n {\\n \\"CompanyTelNumber\\": \\"143243**\\",\\n \\"CompanyTelTitle\\": \\"example\\"\\n }\\n ],\\n \\"MessageDestinationCountry\\": [\\n \\"[\\\\\\"61|es]\\"\\n ],\\n \\"MessageSessionName\\": \\"Message Session Name\\",\\n \\"SuspensionDate\\": \\"SuspensionDate\\",\\n \\"CompanyEnglishName\\": \\"Company English Name\\"\\n },\\n \\"Id\\": \\"id\\",\\n \\"Modifier\\": \\"1\\",\\n \\"RequestNo\\": \\"45345435435\\",\\n \\"RequestType\\": \\"viber_open\\",\\n \\"AliUid\\": \\"21432\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Viber待审核单', + ], + 'GetChatappOpenStatus' => [ + 'summary' => '查询ChatApp开通状态', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '130645', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'OpenStatus' => [ + 'description' => '开通状态', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"OpenStatus\\": true\\n}","type":"json"}]', + 'title' => '查询ChatApp开通状态', + ], + 'GetCustomerSite' => [ + 'summary' => '查询客户来源站点', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3R938***', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => 'cn', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'You have not subscribed to the specified product.', + 'errorCode' => 'Product.Unsubscript', + ], + [ + 'errorMessage' => 'You are not authorized to perform the operation.', + 'errorCode' => 'Ram.PermissionDeny', + ], + [ + 'errorMessage' => 'The system is under flow control.', + 'errorCode' => 'System.LimitControl', + ], + [ + 'errorMessage' => 'The resource does not belong to the current user.', + 'errorCode' => 'Unknown.ResourceOwnerId', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"3R938***\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"cn\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '查询客户来源站点', + ], + 'GetDownloadExcelList' => [ + 'summary' => '下载excel数据', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Condition', + 'in' => 'query', + 'schema' => [ + 'description' => '查询条件', + 'type' => 'string', + 'required' => false, + 'example' => 'aa', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '111', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-01', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-12-01', + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '联系人组ID。', + 'type' => 'array', + 'items' => [ + 'description' => '组ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '[1,2,3]', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CountryNames', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '国家名字', + 'type' => 'array', + 'items' => [ + 'description' => '国家名字列表', + 'type' => 'string', + 'required' => false, + 'example' => '["china","india"]', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认“{}”。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '结果信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '39***', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[API错误码](~~196974~~)。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否调用成功。取值：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"39***\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '下载excel数据', + ], + 'GetFbInstagramPages' => [ + 'summary' => '获取ins的page列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => '个人访问令牌。'."\n" + .'使用阿里云AK+SK或使用STS临时授权方式不需要传该字段', + 'type' => 'string', + 'required' => true, + 'example' => 'ftete3254***', + 'default' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID，实例的唯一标识。', + 'type' => 'string', + 'required' => true, + 'example' => 'inst-8t47hh***5pyj0ps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'hgfh77-gfh55***', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '12534653543', + ], + 'AccountId' => [ + 'description' => '所属账号id', + 'type' => 'string', + 'example' => '1245454654654', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'iwhalecloud', + ], + 'ConnectionStatus' => [ + 'description' => '终端节点连接状态。取值：'."\n" + ."\n" + .'- **Pending**：修改中。'."\n" + ."\n" + .'- **Connecting**：连接中。'."\n" + ."\n" + .'- **Connected**：已连接。'."\n" + ."\n" + .'- **Disconnecting**：断开连接中。'."\n" + ."\n" + .'- **Disconnected**：未连接。'."\n" + ."\n" + .'- **Deleting**：删除中。', + 'type' => 'string', + 'example' => 'Connected', + ], + 'AccountName' => [ + 'description' => '账号名称', + 'type' => 'string', + 'example' => 'Alice', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"hgfh77-gfh55***\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"12534653543\\",\\n \\"AccountId\\": \\"1245454654654\\",\\n \\"PageName\\": \\"iwhalecloud\\",\\n \\"ConnectionStatus\\": \\"Connected\\",\\n \\"AccountName\\": \\"Alice\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Instagram公共主页列表', + ], + 'GetFbMessengerPages' => [ + 'summary' => '获取facebook的pageId列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AccessToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'meta公共主页的token', + 'type' => 'string', + 'required' => true, + 'example' => 'EARDGFDGF12****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'inst-8t47hh***5pyj0ps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'sd2dsd-33*****', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '17433243434', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'iwhalecloud-2', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"sd2dsd-33*****\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"17433243434\\",\\n \\"PageName\\": \\"iwhalecloud-2\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Messenger公共主页列表', + ], + 'GetGroupExist' => [ + 'summary' => '查询群组是否重名', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '分组名称', + 'type' => 'string', + 'required' => true, + 'example' => 'aaa', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认“{}”。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'string', + 'example' => 'False', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": \\"False\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询群组是否重名', + ], + 'GetPledgeTemplateAddress' => [ + 'summary' => '下载保证函模板的地址', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'IndustryType', + 'in' => 'query', + 'schema' => [ + 'description' => '行业种类', + 'type' => 'string', + 'required' => false, + 'example' => 'it', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => false, + 'example' => 'cams-x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '响应信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'example' => 'https://******', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '表示是否调用成功。'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '保证函模板下载地址', + ], + 'GetViberByRequestNo' => [ + 'summary' => '通过requestNo查询申请单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219906', + 'abilityTreeNodes' => [ + 'FEATUREcamsCCB2BU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestNo', + 'in' => 'query', + 'schema' => [ + 'description' => '申请单号', + 'type' => 'string', + 'required' => true, + 'example' => '86512358****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8**9-A94866411B2O'."\n", + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'AuditResult' => [ + 'description' => '审核结果。', + 'type' => 'string', + 'example' => 'pass', + ], + 'Creator' => [ + 'description' => '创建者', + 'type' => 'string', + 'example' => '11', + ], + 'Reason' => [ + 'description' => '审核意见。', + 'type' => 'string', + 'example' => 'aa', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1753236426000', + ], + 'SubscriberCode' => [ + 'description' => '订户编码', + 'type' => 'string', + 'example' => '4534**', + ], + 'MaapServiceNo' => [ + 'description' => 'Viber服务号', + 'type' => 'string', + 'example' => '735221', + ], + 'State' => [ + 'description' => '状态', + 'type' => 'string', + 'example' => 'A', + ], + 'AuditTime' => [ + 'description' => '审核时间', + 'type' => 'string', + 'example' => '1785465', + ], + 'GmtModifier' => [ + 'description' => '修改时间', + 'type' => 'string', + 'example' => '17833636', + ], + 'Id' => [ + 'description' => 'ID。', + 'type' => 'string', + 'example' => '11', + ], + 'AuditRecord' => [ + 'description' => '审核内容', + 'type' => 'object', + 'properties' => [ + 'ContactMail' => [ + 'description' => '联系邮箱', + 'type' => 'string', + 'example' => '联系邮箱', + ], + 'CompanyLegalName' => [ + 'description' => '公司法定名称', + 'type' => 'string', + 'example' => 'xxxxxxcompany', + ], + 'LetterGuarantee' => [ + 'description' => '保证函地址', + 'type' => 'string', + 'example' => 'https://xxxxxxxxxx', + ], + 'IndustryInvolved' => [ + 'description' => '所属行业', + 'type' => 'string', + 'example' => 'cateringServices', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '国际目的地国家或地区', + 'type' => 'array', + 'items' => [ + 'description' => '国际目的地国家或地区', + 'type' => 'string', + 'example' => '["355|AL"]', + ], + 'example' => '', + ], + 'CompleteAddressOfHeadquarters' => [ + 'description' => '总部完整地址', + 'type' => 'string', + 'example' => 'address', + ], + 'MessageEnableDate' => [ + 'description' => '商业消息启用时间', + 'type' => 'string', + 'example' => '2025-08-05', + ], + 'BusinessLicenseRegistrationNumber' => [ + 'description' => '营业执照号码', + 'type' => 'string', + 'example' => '43645465465', + ], + 'CompanyLegalPerson' => [ + 'description' => '公司法人名称', + 'type' => 'string', + 'example' => 'jack', + ], + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'string', + 'example' => 'address', + ], + 'CompanyAddressTitle' => [ + 'description' => '公司地址标题', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + 'example' => '', + ], + 'CompanyRegisteredCountry' => [ + 'description' => '公司注册地', + 'type' => 'string', + 'example' => 'beijing', + ], + 'AgeLimit' => [ + 'description' => '年龄限制', + 'type' => 'string', + 'example' => 'eighteenUp', + ], + 'IndustryDescription' => [ + 'description' => '行业说明', + 'type' => 'string', + 'example' => 'Description', + ], + 'WebAddress' => [ + 'description' => '公司网址', + 'type' => 'string', + 'example' => 'https://xxxxxx', + ], + 'EnableAutoReply' => [ + 'description' => '是否启用自动回复', + 'type' => 'string', + 'example' => 'N', + ], + 'NowRecovery' => [ + 'description' => '恢复', + 'type' => 'string', + 'example' => 'NowRecovery', + ], + 'RecoveryDate' => [ + 'description' => '恢复日期', + 'type' => 'string', + 'example' => '2025-11-11', + ], + 'BusinessAccountName' => [ + 'description' => '商业账户名称', + 'type' => 'string', + 'example' => 'aaaa', + ], + 'ApplyReason' => [ + 'description' => '申请理由。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'Logo' => [ + 'description' => 'logo地址', + 'type' => 'array', + 'items' => [ + 'description' => '集合', + 'type' => 'string', + 'example' => '["http://xxx","http://xxxx"]', + ], + 'example' => '', + ], + 'ReplyContent' => [ + 'description' => '自动回复内容', + 'type' => 'string', + 'example' => 'aaa', + ], + 'CompanyProfile' => [ + 'description' => '公司简介', + 'type' => 'string', + 'example' => 'new', + ], + 'CompanyTel' => [ + 'description' => '公司电话', + 'type' => 'array', + 'items' => [ + 'description' => '对象', + 'type' => 'object', + 'properties' => [ + 'CompanyTelNumber' => [ + 'description' => '公司电话', + 'type' => 'string', + 'example' => '134213213', + ], + 'CompanyTelTitle' => [ + 'description' => '标题', + 'type' => 'string', + 'example' => 'xxx', + ], + ], + ], + 'example' => '', + ], + 'OtherLetterGuarantee' => [ + 'description' => '补充信息地址', + 'type' => 'string', + 'example' => 'https://wwwxxxx', + ], + 'MessageDialogueIntroduction' => [ + 'description' => '商业消息对话简介', + 'type' => 'string', + 'example' => 'aaa', + ], + 'MessageDestinationCountry' => [ + 'description' => '本地目的地或地区', + 'type' => 'array', + 'items' => [ + 'description' => '集合', + 'type' => 'string', + 'example' => '["61|es"]', + ], + 'example' => '', + ], + 'SuspensionDate' => [ + 'description' => 'SuspensionDate', + 'type' => 'string', + 'example' => 'SuspensionDate', + ], + 'MessageSessionName' => [ + 'description' => '商业消息对话名称', + 'type' => 'string', + 'example' => 'name', + ], + 'CompanyEnglishName' => [ + 'description' => '公司英文名称', + 'type' => 'string', + 'example' => 'english', + ], + ], + 'example' => '', + ], + 'Modifier' => [ + 'description' => '修改人', + 'type' => 'string', + 'example' => '11', + ], + 'RequestNo' => [ + 'description' => '申请唯一号码', + 'type' => 'string', + 'example' => '5435435435', + ], + 'RequestType' => [ + 'description' => '请求类型', + 'type' => 'string', + 'example' => 'viberOpen', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8**9-A94866411B2O\\\\n\\",\\n \\"Data\\": {\\n \\"AuditResult\\": \\"pass\\",\\n \\"Creator\\": \\"11\\",\\n \\"Reason\\": \\"aa\\",\\n \\"GmtCreate\\": \\"1753236426000\\",\\n \\"SubscriberCode\\": \\"4534**\\",\\n \\"MaapServiceNo\\": \\"735221\\",\\n \\"State\\": \\"A\\",\\n \\"AuditTime\\": \\"1785465\\",\\n \\"GmtModifier\\": \\"17833636\\",\\n \\"Id\\": \\"11\\",\\n \\"AuditRecord\\": {\\n \\"ContactMail\\": \\"联系邮箱\\",\\n \\"CompanyLegalName\\": \\"xxxxxxcompany\\",\\n \\"LetterGuarantee\\": \\"https://xxxxxxxxxx\\",\\n \\"IndustryInvolved\\": \\"cateringServices\\",\\n \\"MessageDestinationInternationalCountry\\": [\\n \\"[\\\\\\"355|AL\\\\\\"]\\"\\n ],\\n \\"CompleteAddressOfHeadquarters\\": \\"address\\",\\n \\"MessageEnableDate\\": \\"2025-08-05\\",\\n \\"BusinessLicenseRegistrationNumber\\": \\"43645465465\\",\\n \\"CompanyLegalPerson\\": \\"jack\\",\\n \\"CompanyAddress\\": [\\n {\\n \\"CompanyAddress\\": \\"address\\",\\n \\"CompanyAddressTitle\\": \\"111\\"\\n }\\n ],\\n \\"CompanyRegisteredCountry\\": \\"beijing\\",\\n \\"AgeLimit\\": \\"eighteenUp\\",\\n \\"IndustryDescription\\": \\"Description\\",\\n \\"WebAddress\\": \\"https://xxxxxx\\",\\n \\"EnableAutoReply\\": \\"N\\",\\n \\"NowRecovery\\": \\"NowRecovery\\",\\n \\"RecoveryDate\\": \\"2025-11-11\\",\\n \\"BusinessAccountName\\": \\"aaaa\\",\\n \\"ApplyReason\\": \\"aaa\\",\\n \\"Logo\\": [\\n \\"[\\\\\\"http://xxx\\\\\\",\\\\\\"http://xxxx\\\\\\"]\\"\\n ],\\n \\"ReplyContent\\": \\"aaa\\",\\n \\"CompanyProfile\\": \\"new\\",\\n \\"CompanyTel\\": [\\n {\\n \\"CompanyTelNumber\\": \\"134213213\\",\\n \\"CompanyTelTitle\\": \\"xxx\\"\\n }\\n ],\\n \\"OtherLetterGuarantee\\": \\"https://wwwxxxx\\",\\n \\"MessageDialogueIntroduction\\": \\"aaa\\",\\n \\"MessageDestinationCountry\\": [\\n \\"[\\\\\\"61|es\\\\\\"]\\"\\n ],\\n \\"SuspensionDate\\": \\"SuspensionDate\\",\\n \\"MessageSessionName\\": \\"name\\",\\n \\"CompanyEnglishName\\": \\"english\\"\\n },\\n \\"Modifier\\": \\"11\\",\\n \\"RequestNo\\": \\"5435435435\\",\\n \\"RequestType\\": \\"viberOpen\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询申请单', + ], + 'GetViberPauseTimes' => [ + 'summary' => '可以申请暂停的次数', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '附加消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2**9-A94866411B2O'."\n", + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'example' => '11', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2**9-A94866411B2O\\\\n\\",\\n \\"Data\\": 11,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Viber可申请暂停的次数', + ], + 'GetWhatsappConversionApi' => [ + 'summary' => '获取嵌入式授权page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'chatbot-cn-VBe6QXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '7832312', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'DatasetId' => [ + 'description' => '数据集ID', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"7832312\\",\\n \\"PageName\\": \\"aaa\\",\\n \\"DatasetId\\": \\"111\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '获取嵌入式授权', + ], + 'ListAllGroups' => [ + 'summary' => '查询群组列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '608F9CCA-B5EB-3D72-XXXXB25D6D75BDEC'."\n", + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'GroupName' => [ + 'description' => '分组名称', + 'type' => 'string', + 'example' => 'aaa', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1789000', + ], + 'Id' => [ + 'description' => '主键ID', + 'type' => 'string', + 'example' => '5435', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-XXXXB25D6D75BDEC\\\\n\\",\\n \\"Data\\": [\\n {\\n \\"GroupName\\": \\"aaa\\",\\n \\"GmtCreate\\": \\"1789000\\",\\n \\"Id\\": \\"5435\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询群组列表', + ], + 'ListFacebookPosts' => [ + 'summary' => '查询facebook帖子列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866***', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'PermalinkUrl' => [ + 'description' => '永久链接地址', + 'type' => 'string', + 'example' => 'https://xxxxxxx', + ], + 'MediaUrl' => [ + 'description' => '原始素材地址', + 'type' => 'string', + 'example' => 'https://xxxxxx07', + ], + 'CreatedTime' => [ + 'description' => '自定义域名的创建时间。', + 'type' => 'string', + 'example' => '2025-04-08T10:44:48', + ], + 'Message' => [ + 'description' => '响应信息', + 'type' => 'string', + 'example' => 'success', + ], + 'MediaType' => [ + 'description' => '媒体类型', + 'type' => 'string', + 'example' => '1', + ], + 'Id' => [ + 'description' => '任务ID', + 'type' => 'string', + 'example' => '1', + ], + 'RequestNo' => [ + 'description' => '请求号', + 'type' => 'string', + 'example' => '453645465***', + ], + 'FullPicture' => [ + 'description' => '全图', + 'type' => 'string', + 'example' => 'N/A', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866***\\",\\n \\"Data\\": [\\n {\\n \\"PermalinkUrl\\": \\"https://xxxxxxx\\",\\n \\"MediaUrl\\": \\"https://xxxxxx07\\",\\n \\"CreatedTime\\": \\"2025-04-08T10:44:48\\",\\n \\"Message\\": \\"success\\",\\n \\"MediaType\\": \\"1\\",\\n \\"Id\\": \\"1\\",\\n \\"RequestNo\\": \\"453645465***\\",\\n \\"FullPicture\\": \\"N/A\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'facebook帖子列表', + ], + 'ListFlowNodeGroup' => [ + 'summary' => '列举流程组件分组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '254737', + 'abilityTreeNodes' => [ + 'FEATUREcams9OUKUU', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => '请求结果数据。', + 'type' => 'array', + 'items' => [ + 'description' => '请求结果数据。', + 'type' => 'object', + 'properties' => [ + 'PublicExtend' => [ + 'description' => '公共扩展字段', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'string', + 'example' => '0', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Data\\": {\\n \\"Model\\": [\\n {\\n \\"PublicExtend\\": \\"{}\\",\\n \\"Code\\": \\"0\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '列举流程组件分组', + ], + 'ListInstagramPage' => [ + 'summary' => '获取ins的page', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '实例ID。仅支持非阿里云主机。', + 'type' => 'string', + 'required' => true, + 'example' => 'inst-8t47hh***5pyj0ps', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'dsfdsf-3jfj***', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'BeebotInfo' => [ + 'description' => '小蜜信息', + 'type' => 'object', + 'properties' => [ + 'BeebotInstanceId' => [ + 'description' => '小蜜实例id', + 'type' => 'string', + 'example' => 'instance1', + ], + 'BeebotNamespaceId' => [ + 'description' => '命名空间id', + 'type' => 'string', + 'example' => 'name1', + ], + ], + 'example' => '', + ], + 'AgentInfo' => [ + 'description' => '人工座席信息', + 'type' => 'object', + 'properties' => [ + 'AgentKeywords' => [ + 'description' => '人工座席相关配置', + 'type' => 'string', + 'example' => 'aaa,bbb', + ], + 'AgentNoKeywords' => [ + 'description' => '人工座席相关配置', + 'type' => 'string', + 'example' => 'Y', + ], + ], + 'example' => '', + ], + 'InstagramInfo' => [ + 'description' => 'ins主页信息', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '主页id', + 'type' => 'string', + 'example' => '213254324532523', + ], + 'QueueFlag' => [ + 'description' => '是否使用队列方式接收回执。取值：'."\n" + ."\n" + .'- Y：是'."\n" + ."\n" + .'- N：否', + 'type' => 'string', + 'example' => 'Y', + ], + 'HttpFlag' => [ + 'description' => '是否使用HTTP方式接收回执。取值：'."\n" + .'- Y：是'."\n" + .'- N：否', + 'type' => 'string', + 'example' => 'Y', + ], + 'AccountId' => [ + 'description' => '所属账号id', + 'type' => 'string', + 'example' => '176546546464', + ], + 'StatusQueue' => [ + 'description' => '状态报告通知Queue。', + 'type' => 'string', + 'example' => 'AAA', + ], + 'UpQueue' => [ + 'description' => '上行消息通知Queue。', + 'type' => 'string', + 'example' => 'BBB', + ], + 'PageName' => [ + 'description' => '页面名称。', + 'type' => 'string', + 'example' => 'iwhaclecloud-2', + ], + 'ConnectionStatus' => [ + 'description' => '终端节点连接状态，取值：'."\n" + ."\n" + .'- **Pending**：修改中。'."\n" + ."\n" + .'- **Connecting**：连接中。'."\n" + ."\n" + .'- **Connected**：已连接。'."\n" + ."\n" + .'- **Disconnecting**：断开连接中。'."\n" + ."\n" + .'- **Disconnected**：未连接。'."\n" + ."\n" + .'- **Deleting**：删除中。'."\n" + ."\n" + .'- **ServiceDeleted**：终端节点对应的服务已删除。', + 'type' => 'string', + 'example' => 'connected', + ], + 'UpCallbackUrl' => [ + 'description' => 'HTTP方式上行消息接口回调地址。', + 'type' => 'string', + 'example' => 'HTTP://WWW.***.COM', + ], + 'QueueName' => [ + 'description' => 'Queue名称。', + 'type' => 'string', + 'example' => 'aaa', + ], + 'AccountName' => [ + 'description' => '账户名', + 'type' => 'string', + 'example' => 'matrryhtr', + ], + 'StatusCallbackUrl' => [ + 'description' => 'HTTP方式状态报告接口回调地址。', + 'type' => 'string', + 'example' => 'HTTP://WWW.***.COM', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"dsfdsf-3jfj***\\",\\n \\"Data\\": {\\n \\"BeebotInfo\\": {\\n \\"BeebotInstanceId\\": \\"instance1\\",\\n \\"BeebotNamespaceId\\": \\"name1\\"\\n },\\n \\"AgentInfo\\": {\\n \\"AgentKeywords\\": \\"aaa,bbb\\",\\n \\"AgentNoKeywords\\": \\"Y\\"\\n },\\n \\"InstagramInfo\\": {\\n \\"PageId\\": \\"213254324532523\\",\\n \\"QueueFlag\\": \\"Y\\",\\n \\"HttpFlag\\": \\"Y\\",\\n \\"AccountId\\": \\"176546546464\\",\\n \\"StatusQueue\\": \\"AAA\\",\\n \\"UpQueue\\": \\"BBB\\",\\n \\"PageName\\": \\"iwhaclecloud-2\\",\\n \\"ConnectionStatus\\": \\"connected\\",\\n \\"UpCallbackUrl\\": \\"HTTP://WWW.***.COM\\",\\n \\"QueueName\\": \\"aaa\\",\\n \\"AccountName\\": \\"matrryhtr\\",\\n \\"StatusCallbackUrl\\": \\"HTTP://WWW.***.COM\\"\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Instagram公共主页列表', + ], + 'ListInstagramPosts' => [ + 'summary' => '查询instagram帖子列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A***66411B2O', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'PermalinkUrl' => [ + 'description' => '永久链接地址', + 'type' => 'string', + 'example' => 'https://xxxxxxxx', + ], + 'MediaUrl' => [ + 'description' => '原始素材地址', + 'type' => 'string', + 'example' => 'https://qjck.oss-cn-shanghai.aliyuncs.com/xcx/2025-08-29/0bfa1c8d-d35f-2dd5-e082-7b00***ee9.jpg?x-oss-process=image/resize,m_lfit,w_1200', + ], + 'CreatedTime' => [ + 'description' => '创建时间。'."\n", + 'type' => 'string', + 'example' => '2024-09-30T15:53:01+08:00', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'MediaType' => [ + 'description' => '媒体类型', + 'type' => 'string', + 'example' => 'image', + ], + 'Id' => [ + 'description' => '任务主键ID', + 'type' => 'string', + 'example' => '111', + ], + 'FullPicture' => [ + 'description' => '全图', + 'type' => 'string', + 'example' => 'https://xxxxxxxx'."\n", + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：true：成功。false：失败', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A***66411B2O\\",\\n \\"Data\\": [\\n {\\n \\"PermalinkUrl\\": \\"https://xxxxxxxx\\",\\n \\"MediaUrl\\": \\"https://qjck.oss-cn-shanghai.aliyuncs.com/xcx/2025-08-29/0bfa1c8d-d35f-2dd5-e082-7b00***ee9.jpg?x-oss-process=image/resize,m_lfit,w_1200\\",\\n \\"CreatedTime\\": \\"2024-09-30T15:53:01+08:00\\",\\n \\"Message\\": \\"success\\",\\n \\"MediaType\\": \\"image\\",\\n \\"Id\\": \\"111\\",\\n \\"FullPicture\\": \\"https://xxxxxxxx\\\\n\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Instagram帖子列表', + ], + 'ListMarketingFlow' => [ + 'summary' => '查询活动列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '221797', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActivityStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '活动状态', + 'type' => 'string', + 'required' => false, + 'example' => 'sucess', + ], + ], + [ + 'name' => 'RelatedGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联群组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '68', + ], + ], + [ + 'name' => 'RelatedFlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '关联流程id', + 'type' => 'string', + 'required' => false, + 'example' => 'asdfsdfdsfs', + ], + ], + [ + 'name' => 'ActivityName', + 'in' => 'query', + 'schema' => [ + 'description' => '节点任务实例名称', + 'type' => 'string', + 'required' => false, + 'example' => 'werewew', + ], + ], + [ + 'name' => 'ActivityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '活动编码,可使用系统编码，也可修改系统编码使用自定义编码', + 'type' => 'string', + 'required' => false, + 'example' => 'rewrwerw', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页数', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回值的个数。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认“{}”。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'TotalCount' => [ + 'description' => '列表项总个数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'NULL', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CB6122C9-09B5-5926-**476A96CB0', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + 'properties' => [ + 'RelatedFlowName' => [ + 'description' => '关联流程名称', + 'type' => 'string', + 'example' => 'aaa', + ], + 'ActivityStatus' => [ + 'description' => '活动状态', + 'type' => 'string', + 'example' => 'active', + ], + 'ActivityName' => [ + 'description' => '活动名称', + 'type' => 'string', + 'example' => 'aaa', + ], + 'ActivityCode' => [ + 'description' => '活动编码', + 'type' => 'string', + 'example' => '3243243***', + ], + 'ExecutionType' => [ + 'description' => '执行方式', + 'type' => 'string', + 'example' => '1(默认corn)', + ], + 'RelatedGroupId' => [ + 'description' => '关联群组id', + 'type' => 'string', + 'example' => '54354**', + ], + 'SpecificTime' => [ + 'description' => '特定时间(执行方式为2时)', + 'type' => 'string', + 'example' => '特定时间(执行方式为2时)'."\n" + ."\n", + ], + 'Params' => [ + 'description' => '自定义的用户参数。', + 'type' => 'object', + 'example' => '{\\"CustomerLimit\\":false}', + ], + 'BizExtend' => [ + 'description' => '业务扩展信息，默认“{}”。', + 'type' => 'object', + 'example' => '{}', + ], + 'RelatedGroupName' => [ + 'description' => '关联群组名称', + 'type' => 'string', + 'example' => 'AAA', + ], + 'EndDate' => [ + 'description' => '结束时间', + 'type' => 'string', + 'example' => '2025-01-01 XX1:11:11', + ], + 'StartDate' => [ + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2025-01-XX 11:11:11', + ], + 'GmtCreate' => [ + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-XX-01 11:11:11', + ], + 'TenantCode' => [ + 'description' => '租户', + 'type' => 'string', + 'example' => '1111', + ], + 'ActivityDesc' => [ + 'description' => '活动描述', + 'type' => 'string', + 'example' => 'aaa', + ], + 'RelatedFlowCode' => [ + 'description' => '绑定流程编码', + 'type' => 'string', + 'example' => 'dsafdsf***', + ], + 'GmtModifier' => [ + 'description' => '修改时间(已弃用)', + 'type' => 'string', + 'example' => 'N/A', + ], + 'Id' => [ + 'description' => '运营活动ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'CronExpression' => [ + 'description' => '升级开始时间。升级开始时间使用cron表达式。'."\n" + ."\n" + .'例如：`0 0 4 1/1 * ?`表示从每月第一天上午4时开始，每天的上午4时执行升级操作。', + 'type' => 'string', + 'example' => '0 0 4 1/1 * ?', + ], + 'ParamFlag' => [ + 'description' => '是否启用自定义参数', + 'type' => 'string', + 'example' => 'Y', + ], + 'BizCode' => [ + 'description' => '业务租户编码，默认“ALICOM_OPAAS”。', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功，取值如下：'."\n" + ."\n" + .'- true：调用成功。 '."\n" + .'- false：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"TotalCount\\": 15,\\n \\"Message\\": \\"NULL\\",\\n \\"RequestId\\": \\"CB6122C9-09B5-5926-**476A96CB0\\",\\n \\"Data\\": [\\n {\\n \\"RelatedFlowName\\": \\"aaa\\",\\n \\"ActivityStatus\\": \\"active\\",\\n \\"ActivityName\\": \\"aaa\\",\\n \\"ActivityCode\\": \\"3243243***\\",\\n \\"ExecutionType\\": \\"1(默认corn)\\",\\n \\"RelatedGroupId\\": \\"54354**\\",\\n \\"SpecificTime\\": \\"特定时间(执行方式为2时)\\\\n\\\\n\\",\\n \\"Params\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"BizExtend\\": {},\\n \\"RelatedGroupName\\": \\"AAA\\",\\n \\"EndDate\\": \\"2025-01-01 XX1:11:11\\",\\n \\"StartDate\\": \\"2025-01-XX 11:11:11\\",\\n \\"GmtCreate\\": \\"2025-XX-01 11:11:11\\",\\n \\"TenantCode\\": \\"1111\\",\\n \\"ActivityDesc\\": \\"aaa\\",\\n \\"RelatedFlowCode\\": \\"dsafdsf***\\",\\n \\"GmtModifier\\": \\"N/A\\",\\n \\"Id\\": 99,\\n \\"CronExpression\\": \\"0 0 4 1/1 * ?\\",\\n \\"ParamFlag\\": \\"Y\\",\\n \\"BizCode\\": \\"{}\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询营销活动列表', + ], + 'ListViberServiceMessage' => [ + 'summary' => '展示viber申请单服务号卡片', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8e4**96uhvk', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '请求ID。用于出现错误后排查问题'."\n" + .'。', + 'type' => 'string', + 'example' => 'ddhjdn-dnjdnkdjknd**', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'DestinationCountryId' => [ + 'description' => '目的地国家地区编号', + 'type' => 'array', + 'items' => [ + 'description' => '对象集合', + 'type' => 'string', + 'example' => '["213|DZ"]', + ], + 'example' => '', + ], + 'State' => [ + 'description' => '资源状态。', + 'type' => 'string', + 'example' => 'stop', + ], + 'IndustryInvolved' => [ + 'description' => '涉及行业', + 'type' => 'string', + 'example' => '医疗服务', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '国际目的地国家或地区列表', + 'type' => 'array', + 'items' => [ + 'description' => '值', + 'type' => 'string', + 'example' => '阿尔及利亚', + ], + 'example' => '', + ], + 'DestinationInternationalCountryId' => [ + 'description' => '目的地国家地区编号', + 'type' => 'array', + 'items' => [ + 'description' => '值', + 'type' => 'string', + 'example' => '["213|DZ"]', + ], + 'example' => '', + ], + 'MessageDestinationCountry' => [ + 'description' => '目的地国家地区集合', + 'type' => 'array', + 'items' => [ + 'description' => '值', + 'type' => 'string', + 'example' => '阿尔及利亚'."\n", + ], + 'example' => '', + ], + 'BusinessAccountName' => [ + 'description' => '商业账户名称', + 'type' => 'string', + 'example' => '测试', + ], + 'ServiceId' => [ + 'description' => '服务ID。', + 'type' => 'string', + 'example' => '25644', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"ddhjdn-dnjdnkdjknd**\\",\\n \\"Data\\": [\\n {\\n \\"DestinationCountryId\\": [\\n \\"[\\\\\\"213|DZ\\\\\\"]\\"\\n ],\\n \\"State\\": \\"stop\\",\\n \\"IndustryInvolved\\": \\"医疗服务\\",\\n \\"MessageDestinationInternationalCountry\\": [\\n \\"阿尔及利亚\\"\\n ],\\n \\"DestinationInternationalCountryId\\": [\\n \\"[\\\\\\"213|DZ\\\\\\"]\\"\\n ],\\n \\"MessageDestinationCountry\\": [\\n \\"阿尔及利亚\\\\n\\"\\n ],\\n \\"BusinessAccountName\\": \\"测试\\",\\n \\"ServiceId\\": \\"25644\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Viber服务号信息展示', + ], + 'MoveContactToGroup' => [ + 'summary' => '联系人变更群组', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Contacts', + 'in' => 'query', + 'schema' => [ + 'description' => '变更群组的联系人列表', + 'type' => 'string', + 'required' => true, + 'example' => '[{"id":1}]', + ], + ], + [ + 'name' => 'LinkExistGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '关联到已有群组id列表', + 'type' => 'string', + 'required' => false, + 'example' => '[{"id":1}]', + ], + ], + [ + 'name' => 'LinkNewGroups', + 'in' => 'query', + 'schema' => [ + 'description' => '关联到新群组名字列表', + 'type' => 'string', + 'required' => false, + 'example' => '[{"groupName":"aaa"}]', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => '', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '返回对象', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '联系人分组', + ], + 'OpenChatappService' => [ + 'summary' => '开通Chatapp服务', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '3D2FFEE6-368D-532D-87AA-F45B02DD28B7', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '请求响应信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'OpenStatus' => [ + 'description' => '开通服务是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'Product.Unsubscript', + 'errorMessage' => 'You have not subscribed to the specified product.', + ], + [ + 'errorCode' => 'Ram.PermissionDeny', + 'errorMessage' => 'You are not authorized to perform the operation.', + ], + [ + 'errorCode' => 'System.LimitControl', + 'errorMessage' => 'The system is under flow control.', + ], + [ + 'errorCode' => 'Unknown.ResourceOwnerId', + 'errorMessage' => 'The resource does not belong to the current user.', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D2FFEE6-368D-532D-87AA-F45B02DD28B7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"OpenStatus\\": true\\n}","type":"json"}]', + 'title' => '开通Chatapp服务', + ], + 'PauseMarketingFLow' => [ + 'summary' => '暂停服务', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActivityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '活动编码', + 'type' => 'string', + 'required' => false, + 'example' => '439859845**234', + ], + ], + [ + 'name' => 'ActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => '活动ID(已弃用)', + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '调用成功时返回成功信息，调用失败时返回出错信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '监控任务的结果详情。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '暂停营销活动', + ], + 'RemoveContactById' => [ + 'summary' => '当前群组移除单个联系人', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '46546546546**', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人ID', + 'type' => 'string', + 'required' => true, + 'example' => '3456456346**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '移除单个联系人', + ], + 'RequestWhatsappConversionApi' => [ + 'summary' => '请求Whatsapp Conversion api', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '214140', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Meta的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '1939848838', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '客户的SpaceId/实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '929399382', + ], + ], + [ + 'name' => 'RequestData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '请求数据', + 'type' => 'array', + 'items' => [ + 'description' => '请求数据', + 'type' => 'object', + 'properties' => [ + 'DataProcessingOptionsState' => [ + 'description' => '在某些情况下为必要项。（查看下方备注以了解详情。）'."\n" + .'您希望与此数据处理选项相关联的州/省。当前可接受值为 1000（代表加利福尼亚州），或者 0（请求我们为此事件进行地理定位）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '26', + ], + 'UserData' => [ + 'description' => '包含客户信息数据的映射。', + 'type' => 'object', + 'required' => true, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"currency":"USD", "value": 1}', + 'description' => 'data', + ], + 'example' => '', + ], + 'EventName' => [ + 'description' => '- 标准事件或自定义事件的名称。此字段用于删除由网站（通过Meta Pixel 像素代码）或应用（通过 SDK 或应用事件 API）以及转化 API 发送的重复事件。event_id 参数也用于删除重复事件。'."\n" + ."\n" + .'- 对于相同的客户操作，浏览器事件或应用事件的 event 应与服务器事件的 event_name 相符。如果我们在 48 小时内发送的事件之间找到匹配项，则只考虑第一个事件。如果几乎同一时间收到服务器和浏览器/应用事件（即彼此相差 5 分钟以内），则将优先考虑浏览器/应用事件。详细了解删除重复的 Pixel 像素代码事件和服务器事件。', + 'type' => 'string', + 'required' => true, + 'example' => 'Purchase', + ], + 'OptOut' => [ + 'description' => '表示不应将此事件用于广告投放优化的标记。设置为 true 时，该事件仅可用作归因条件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AppData' => [ + 'description' => '应用事件必要参数'."\n" + ."\n" + .'这些参数用于将应用数据和设备信息分享给转化 API。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'data', + 'example' => '{}', + ], + 'example' => '', + ], + 'EventTime' => [ + 'description' => 'Unix 时间戳（以秒为单位），表示事件的实际发生时间。指定时间可能早于您将事件发送至 Facebook 的时间。其目的在于实现批处理和服务器性能优化。您必须以格林威治标准时间 (GMT) 时区格式发送该日期。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1709201870', + ], + 'ExtInfo' => [ + 'description' => '应用事件必要参数'."\n" + ."\n" + .'扩展设备信息，例如屏幕的宽度和高度。此参数是一个数组，各个值之间使用逗号分隔。使用 extinfo 时，所有值均为必要项，并且必须按照以下索引顺序排列。如果缺少某个值，则需使用空字符串作为占位符填充。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{}', + 'description' => 'data', + ], + 'example' => '', + ], + 'CustomData' => [ + 'description' => '包含事件其他企业数据的映射。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{}', + 'description' => 'data', + ], + 'example' => '', + ], + 'EventId' => [ + 'description' => '此编号可以是广告主选定的任何唯一字符串。参数 event_name 和 event_id 用于删除由网站（通过 Meta Pixel 像素代码）或应用（通过 SDK 或应用事件 API）以及转化 API 发送的重复事件。请注意，虽然我们将 event_id 标记为可选项，但是建议您在删除重复事件时采用此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '20029399299', + ], + 'DataProcessingOptions' => [ + 'description' => '您希望为特定事件启用的处理选项。对于受限数据使用，当前可接受值为 LDU。您可以发送一个空数组来明确指定，不得使用“受限数据使用”限制来处理此事件。', + 'type' => 'array', + 'items' => [ + 'description' => 'data', + 'type' => 'string', + 'required' => false, + 'example' => ' [] ', + ], + 'required' => false, + 'example' => '', + ], + 'MessagingChannel' => [ + 'description' => '来源，固定为: whatsapp', + 'type' => 'string', + 'required' => false, + 'example' => 'whatsapp', + ], + 'ActionSource' => [ + 'description' => '您可通过此字段指定转化发生的位置。了解事件发生的位置有助于确保将广告投放至正确的受众。使用转化 API，即表示您同意：就您所知 action_source 参数准确无误。'."\n" + ."\n\n" + .'您可在 action_source 字段中发送的值如下：'."\n" + ."\n\n" + .'- email — 转化通过邮件发生。'."\n" + .'- website — 转化在网站上完成。'."\n" + .'- app — 转化在移动应用上完成。'."\n" + .'- phone_call — 转化通过电话完成。'."\n" + .'- chat — 转化通过消息应用、短信或在线消息功能完成。'."\n" + .'- physical_store — 转化在实体店面对面完成。'."\n" + .'- system_generated — 转化自动发生，例如将订阅续费设置为每月自动支付。'."\n" + .'- other — 转化通过本文未列出的其他方式完成。'."\n" + ."\n" + .'注意：所有操作来源值都支持广告成效衡量和自定义受众创建功能。所有操作来源（除 physical_store 外）都支持广告优化功能。', + 'type' => 'string', + 'required' => true, + 'example' => 'business_messaging', + ], + 'DataProcessingOptionsCountry' => [ + 'description' => '如果您在 data_processing_options 下发送 LDU，则为必要项。'."\n" + .'您希望与此数据处理选项相关联的国家/地区。当前可接受值为 1（代表美国），或者 0（请求我们为此事件进行地理定位）。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'EventSourceUrl' => [ + 'description' => '事件发生的浏览器网址。此网址必须以 http:// 或 https:// 开头，并且应与已认证的网域相匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://alibaba.com', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '请求Whatsapp Conversion api', + 'description' => '本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'UpdateAuditRequest' => [ + 'summary' => '修改viber申请单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218664', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RequestNo', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改的请求编号。', + 'type' => 'string', + 'required' => true, + 'example' => '114624518**5956096', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8pi**urn5s', + ], + ], + [ + 'name' => 'AuditResult', + 'in' => 'query', + 'schema' => [ + 'description' => '审核结果。', + 'type' => 'string', + 'required' => false, + 'example' => 'unAudit', + ], + ], + [ + 'name' => 'AuditRecord', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'viber审核项。', + 'type' => 'object', + 'properties' => [ + 'ContactMail' => [ + 'description' => '联系邮箱。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'CompanyLegalName' => [ + 'description' => '公司法定名称', + 'type' => 'string', + 'required' => false, + 'example' => 'XXX有限公司', + ], + 'LetterGuarantee' => [ + 'description' => '保证函(下载地址)', + 'type' => 'string', + 'required' => false, + 'example' => '保证函下载地址(https://xxx.xxx.xxx)', + ], + 'IndustryInvolved' => [ + 'description' => '所属行业', + 'type' => 'string', + 'required' => false, + 'example' => 'telecommunicationsAndIT', + ], + 'MessageDestinationInternationalCountry' => [ + 'description' => '国际目的地国家和地区', + 'type' => 'array', + 'items' => [ + 'description' => '国际目的地国家和地区列表', + 'type' => 'string', + 'required' => false, + 'example' => '["1|AI","374|AM"]', + ], + 'required' => false, + 'example' => '', + ], + 'CompleteAddressOfHeadquarters' => [ + 'description' => '总部完整地址', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxstreet', + ], + 'MessageEnableDate' => [ + 'description' => '商业消息启用日期(GMT时区)', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-07', + ], + 'BusinessLicenseRegistrationNumber' => [ + 'description' => '营业职照注册号码', + 'type' => 'string', + 'required' => false, + 'example' => '9211515**345', + ], + 'CompanyLegalPerson' => [ + 'description' => '公司法人名称', + 'type' => 'string', + 'required' => false, + 'example' => '马**', + ], + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'array', + 'items' => [ + 'description' => '公司地址详情', + 'type' => 'object', + 'properties' => [ + 'CompanyAddress' => [ + 'description' => '公司地址', + 'type' => 'string', + 'required' => false, + 'example' => '123 Sunshine Street, City, Country', + ], + 'CompanyAddressTitle' => [ + 'description' => '公司地址标题', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx company', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + 'CompanyRegisteredCountry' => [ + 'description' => '公司注册国家或者地区', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'AgeLimit' => [ + 'description' => '年龄限制', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'unlimited' => 'unlimited', + 'eighteenUp' => 'eighteenUp', + 'twentyOneUp' => 'twentyOneUp', + ], + 'example' => 'unlimited', + ], + 'IndustryDescription' => [ + 'description' => '行业说明', + 'type' => 'string', + 'required' => false, + 'example' => 'description', + ], + 'WebAddress' => [ + 'description' => '公司网址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.xxx.xxx.com', + ], + 'EnableAutoReply' => [ + 'description' => '启用自动回复(该字段已弃用)', + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + 'RecoveryDate' => [ + 'description' => '恢复日期', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-07', + ], + 'BusinessAccountName' => [ + 'description' => '商业账户名称', + 'type' => 'string', + 'required' => false, + 'example' => 'testaccount', + ], + 'ApplyReason' => [ + 'description' => '申请理由。', + 'type' => 'string', + 'required' => false, + 'example' => 'reason', + ], + 'Logo' => [ + 'description' => 'logo', + 'type' => 'array', + 'items' => [ + 'description' => 'logo集合(下载地址)', + 'type' => 'string', + 'required' => false, + 'example' => '[xxx,xxx,xxx]', + ], + 'required' => false, + 'example' => '', + ], + 'ReplyContent' => [ + 'description' => '回复内容(已弃用)', + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + 'CompanyProfile' => [ + 'description' => '公司简介', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + 'CompanyTel' => [ + 'description' => '公司电话', + 'type' => 'array', + 'items' => [ + 'description' => '公司电话详情', + 'type' => 'object', + 'properties' => [ + 'CompanyTelNumber' => [ + 'description' => '公司电话号码', + 'type' => 'string', + 'required' => false, + 'example' => '07364245xxxx', + ], + 'CompanyTelTitle' => [ + 'description' => '电话号码标题', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + 'MessageDialogueIntroduction' => [ + 'description' => '商业消息对话简介', + 'type' => 'string', + 'required' => false, + 'example' => 'hello!', + ], + 'OtherLetterGuarantee' => [ + 'description' => '补充资料地址', + 'type' => 'string', + 'required' => false, + 'example' => 'https://xxx.xxx.com', + ], + 'MessageDestinationCountry' => [ + 'description' => '本地目的地国家或地区', + 'type' => 'array', + 'items' => [ + 'description' => '本地目的地国家或地区集合', + 'type' => 'string', + 'required' => false, + 'example' => '["1|AI","374|AM"]', + ], + 'required' => false, + 'example' => '', + ], + 'MessageSessionName' => [ + 'description' => '商业消息对话名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'SuspensionDate' => [ + 'description' => '已弃用', + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + 'CompanyEnglishName' => [ + 'description' => '公司英文名称', + 'type' => 'string', + 'required' => false, + 'example' => 'baidu', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '返回RequestNo', + 'type' => 'object', + 'example' => '14111561****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '修改viber申请单', + ], + 'UpdateGroupName' => [ + 'summary' => '群组改名', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '群组ID。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '群组名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'OK：代表请求成功。'."\n" + ."\n" + .'其他错误码，请参见错误码列表。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '修改群组名称', + ], + 'UpdateMarketingFLow' => [ + 'summary' => '修改营销活动信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ActivityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的活动编码', + 'type' => 'string', + 'required' => false, + 'example' => '115311507XXXX49888', + ], + ], + [ + 'name' => 'ActivityId', + 'in' => 'query', + 'schema' => [ + 'description' => '要修改的活动ID', + 'type' => 'string', + 'required' => false, + 'example' => '674574575658675XX', + ], + ], + [ + 'name' => 'ActivityName', + 'in' => 'query', + 'schema' => [ + 'description' => '活动名称', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-25 09:59:00', + ], + ], + [ + 'name' => 'ActivityDesc', + 'in' => 'query', + 'schema' => [ + 'description' => '活动描述', + 'type' => 'string', + 'required' => false, + 'example' => '活动描述', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间', + 'type' => 'string', + 'required' => false, + 'example' => '2025-11-26 09:59:00', + ], + ], + [ + 'name' => 'ExecutionType', + 'in' => 'query', + 'schema' => [ + 'description' => '执行方式(固定传1，cron)', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => '时间周期调度的cron表达式。', + 'type' => 'string', + 'required' => false, + 'example' => '0 59 9 */1 * ?', + ], + ], + [ + 'name' => 'RelatedGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '关联群组id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '114345654645XX', + ], + ], + [ + 'name' => 'RelatedFlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '关联流程code', + 'type' => 'string', + 'required' => false, + 'example' => 'cf-kr3k31**mfeir8w', + ], + ], + [ + 'name' => 'RelatedFlowName', + 'in' => 'query', + 'schema' => [ + 'description' => '关联流程名字', + 'type' => 'string', + 'required' => false, + 'example' => 'testflow', + ], + ], + [ + 'name' => 'ParamFlag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否自定义传参', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Y' => 'Y', + 'N' => 'N', + ], + 'example' => 'Y:传入自定义参数 N:不传参数', + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义传参', + 'type' => 'object', + 'required' => false, + 'example' => '{"testEmail":"wy****[email protected]"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'ewtrew-fghdfg43564ZZ', + ], + 'Data' => [ + 'description' => '监控任务的结果详情。', + 'type' => 'object', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"true\\",\\n \\"RequestId\\": \\"ewtrew-fghdfg43564ZZ\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '修改营销活动信息', + ], + 'QueryMMLActive' => [ + 'summary' => '查询营销消息是否生效', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269855', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => false, + 'example' => 'erer-retreerew**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '响应信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据对像。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询MML状态', + ], + 'ListBindDmAccount' => [ + 'summary' => '查询绑定的dm账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269618', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '返回信息。当请求成功时，返回成功信息；当请求失败时，返回失败原因。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'xxx-xx**', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '实例名称。', + 'type' => 'string', + 'example' => 'ins', + ], + 'InstanceId' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'example' => 'cams-*', + ], + 'AccountCode' => [ + 'description' => '账号编码', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ExtendAttr' => [ + 'description' => '扩展属性', + 'type' => 'object', + 'properties' => [ + 'SendType' => [ + 'description' => '发送类型', + 'type' => 'string', + 'example' => 'batch', + ], + 'AccountName' => [ + 'description' => '账号名称', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + 'example' => '', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"xxx-xx**\\",\\n \\"Data\\": [\\n {\\n \\"InstanceName\\": \\"ins\\",\\n \\"InstanceId\\": \\"cams-*\\",\\n \\"AccountCode\\": \\"[email protected]\\",\\n \\"ExtendAttr\\": {\\n \\"SendType\\": \\"batch\\",\\n \\"AccountName\\": \\"[email protected]\\"\\n }\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询绑定的邮箱账号', + ], + 'UnbindDmAccount' => [ + 'summary' => '解绑邮件账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269619', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-*', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'xx-xx***', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功。'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"xx-xx***\\",\\n \\"Data\\": \\"NONE\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '解绑Dm账号', + ], + 'ListDmTag' => [ + 'summary' => '查询DM的tag', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269621', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回值的个数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '页号', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'hgfh77-gfh55***', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '标签名称。', + 'type' => 'string', + 'example' => 'xx', + ], + 'TagDescription' => [ + 'description' => '标签描述', + 'type' => 'string', + 'example' => 'xx', + ], + 'TagId' => [ + 'description' => '标签ID。', + 'type' => 'string', + 'example' => 'xx', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"hgfh77-gfh55***\\",\\n \\"Total\\": 42,\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"xx\\",\\n \\"TagDescription\\": \\"xx\\",\\n \\"TagId\\": \\"xx\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '查询Dm Tag列表', + ], + 'BindDmAccount' => [ + 'summary' => '绑定DM账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269620', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AccountCode', + 'in' => 'query', + 'schema' => [ + 'description' => '账户Code', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'ExtendAttr', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '扩展属性', + 'type' => 'object', + 'properties' => [ + 'SendType' => [ + 'description' => '发送类型', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + 'AccountName' => [ + 'description' => '账号名称。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '绑定DM账号', + ], + 'ListDmAccount' => [ + 'summary' => '查询账号下的Dm账号', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '269622', + 'abilityTreeNodes' => [ + 'FEATUREcams2DCA0B', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '分页页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页返回值的个数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SendType', + 'in' => 'query', + 'schema' => [ + 'description' => '发送类型', + 'type' => 'string', + 'required' => false, + 'example' => 'batch', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '搜索关键字。', + 'type' => 'string', + 'required' => false, + 'example' => 'a', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'xis-sx***', + ], + 'Total' => [ + 'description' => '总记录条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Sendtype' => [ + 'description' => '发信地址类型。取值：'."\n" + ."\n" + .'- batch：批量邮件'."\n" + .'- trigger：触发邮件', + 'type' => 'string', + 'example' => 'trigger', + ], + 'CreateTime' => [ + 'description' => '创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743579634000', + ], + 'MailAddressId' => [ + 'description' => '邮箱地址ID', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AccountName' => [ + 'description' => '账户名', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"xis-sx***\\",\\n \\"Total\\": 1,\\n \\"Data\\": [\\n {\\n \\"Sendtype\\": \\"trigger\\",\\n \\"CreateTime\\": 1743579634000,\\n \\"MailAddressId\\": \\"[email protected]\\",\\n \\"AccountName\\": \\"[email protected]\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询账号下的Dm账号列表', + ], + 'UpdateWabaMmlStatus' => [ + 'summary' => '更新waba的mml状态', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '271036', + 'abilityTreeNodes' => [ + 'FEATUREcamsB6GVVZ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'waba Id。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'meta嵌入式授权编码', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/实例ID。即通道ID，在[通道管理](https://chatapp.console.aliyun.com/ChannelsManagement)界面查看。', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝的详细原因。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'example' => '1', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Model\\": 1,\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'mml嵌入式完成后，修改mml状态', + ], + 'GetChatFlowMetric' => [ + 'summary' => '获取ChatFlow运行数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '274825', + 'abilityTreeNodes' => [ + 'FEATUREcamsFP3L4Z', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '业务租户编码，默认：ALICOM_OPAAS。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务扩展信息，默认为一个空集合。', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时刻。时间戳，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1751299200', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时刻。时间戳，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1751385599', + ], + ], + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '流程编码。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面查看流程编码。', + 'type' => 'string', + 'required' => false, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '流程版本。在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入流程编辑器画布界面查看流程版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控项名称。取值：'."\n" + ."\n" + .'- nodeUsageStatistics：节点使用统计。'."\n" + ."\n" + .'- nodeErrorDetails：节点错误明细。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'nodeUsageStatistics', + ], + ], + [ + 'name' => 'MetricParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监控项查询的扩展参数。当MetricName为nodeErrorDetails时，需传入一段JSON数据。JSON字段取值：'."\n" + ."\n" + .'- pageNo：当前页数。'."\n" + ."\n" + .'- pageSize：每页显示数量。'."\n" + ."\n" + .'- nodeId：节点ID，在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面点击流程名称进入画布编排界面复制节点ID。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "pageNo": 1,'."\n" + .' "pageSize": 20,'."\n" + .' "nodeId": "SendWhatsAppMessage#H7fKq5rM"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '错误码。更多详情请参见[错误码](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '获取ChatFlow运行数据', + 'description' => '- 在调用此接口前，请确保您创建的流程已上线且已触发流程。'."\n" + ."\n" + .'- 若您的流程未上线，可在[流程编辑器](https://chatapp.console.aliyun.com/ChatFlowBuilder)界面单击流程名称进入画布编排界面手动上线流程或通过[OnlineFlowVersion](~~2937203~~)接口上线流程。'."\n" + ."\n" + .'- 触发器类型为手动的流程需要通过[TriggerChatFlow](~~2859101~~)接口触发流程或在[营销活动管理](https://chatapp.console.aliyun.com/MarketingActivityManagement)界面通过关联营销活动触发流程。'."\n" + ."\n" + .'- 触发器类型为非手动的流程则无需手动触发流程，在对应绑定的商家账号给商家发送消息以后就会触发流程。', + ], + 'ModifyChatappTemplateProperties' => [ + 'summary' => '修改模板上的部分属性。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '274207', + 'abilityTreeNodes' => [ + 'FEATUREcamsDKDS4Q', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '模板编码。', + 'type' => 'string', + 'required' => true, + 'example' => '929938***', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '模板语言。 详细语言代码，请参见[语言代码](~~463420~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。'."\n" + ."\n" + .'- **WHATSAPP**', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户的实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-idk***', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'query', + 'schema' => [ + 'description' => 'Utility模板在变更类型后是否阻塞发送', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AllowSend', + 'in' => 'query', + 'schema' => [ + 'description' => '是否允许发送', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '399s88-***'."\n", + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '是否调用成功：'."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"399s88-***\\\\n\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '修改模板部分属性', + ], + 'ListPageAdAccount' => [ + 'summary' => '查询page绑定的广告账户列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '230***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '39**', + ], + 'Message' => [ + 'description' => '错误描述信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '返回数据对象。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'example' => '2030***', + ], + 'AdAccountName' => [ + 'description' => '广告账户名称', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Currency' => [ + 'description' => '币种。', + 'type' => 'string', + 'example' => 'USD', + ], + 'AdAccountId' => [ + 'description' => 'Meta 广告账户ID', + 'type' => 'string', + 'example' => '29393****', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"39**\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"PageId\\": \\"2030***\\",\\n \\"AdAccountName\\": \\"Alibaba\\",\\n \\"Currency\\": \\"USD\\",\\n \\"AdAccountId\\": \\"29393****\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '查询主页广告账户', + ], + 'CreateMessengerPage' => [ + 'summary' => 'Messenger营销消息嵌入式完成授权后绑定page到chatapp实例', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Messenger 的PageId', + 'type' => 'string', + 'required' => true, + 'example' => '19283***', + ], + ], + [ + 'name' => 'AuthenticationCode', + 'in' => 'query', + 'schema' => [ + 'description' => '嵌入式完成后获得的授权码', + 'type' => 'string', + 'required' => true, + 'example' => 'EAA****', + ], + ], + [ + 'name' => 'AdAccountIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '授权的广告账户ID', + 'type' => 'array', + 'items' => [ + 'description' => '广告账户ID', + 'type' => 'string', + 'required' => true, + 'example' => '2393***', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'ISV子客户的SpaceId/直客客户的实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-s***', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business平台Id。', + 'type' => 'string', + 'required' => true, + 'example' => '293***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求唯一ID。', + 'type' => 'string', + 'example' => '39***', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~196974~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- true：成功。'."\n" + ."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"39***\\",\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => '嵌入式授权messenger', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cams.ap-southeast-1.aliyuncs.com', + ], + ], +]; |