diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/cams/2020-06-06 | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/cams/2020-06-06')
| -rw-r--r-- | data/en_us/cams/2020-06-06/api-docs.php | 26919 |
1 files changed, 26919 insertions, 0 deletions
diff --git a/data/en_us/cams/2020-06-06/api-docs.php b/data/en_us/cams/2020-06-06/api-docs.php new file mode 100644 index 0000000..435d217 --- /dev/null +++ b/data/en_us/cams/2020-06-06/api-docs.php @@ -0,0 +1,26919 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'cams', + 'version' => '2020-06-06', + ], + 'directories' => [ + [ + 'id' => 389325, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddChatGroup', + 'AddChatGroupInviteLink', + 'DeleteChatGroupInviteLink', + 'DeleteChatGroupParticipants', + 'DeleteChatGroupParticipants', + 'ListChatGroup', + 'UpdateChatGroup', + 'DeleteChatGroup', + ], + ], + [ + 'id' => 389333, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SyncMessengerSubscriptionToken', + 'SyncMessageCampaign', + 'ListMessengerSubscriptionToken', + 'ListMessageCampaign', + 'ListCustomAudience', + 'ListChatGroupParticipants', + 'GetMessageCampaignInsights', + 'DeleteMessageCampaign', + 'CreateMessageCampaign', + 'CreateCustomAudience', + 'AddCustomAudienceUser', + ], + ], + [ + 'id' => 389345, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ChangeResourceGroup', + 'CreateInstance', + 'DeleteInstance', + 'ListInstance', + 'QueryInstance', + 'UpdateInstance', + ], + ], + [ + 'id' => 389352, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'TriggerChatFlow', + ], + ], + [ + 'id' => 389354, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateFlow', + 'ListFlow', + 'GetFlow', + 'SyncFlow', + 'ModifyFlow', + 'UpdateFlowJSONAsset', + 'GetFlowJSONAssest', + 'GetFlowPreviewUrl', + 'PublishFlow', + 'DeprecateFlow', + 'DeleteFlow', + ], + ], + [ + 'id' => 389366, + 'title' => null, + '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' => null, + 'type' => 'directory', + 'children' => [ + 'GetWhatsappHealthStatus', + 'UpdateConversationalAutomation', + 'GetConversationalAutomation', + 'GetPhoneEncryptionPublicKey', + 'UpdatePhoneEncryptionPublicKey', + 'UpdatePhoneMessageQrdl', + 'ListPhoneMessageQrdl', + 'DeletePhoneMessageQrdl', + 'CreatePhoneMessageQrdl', + 'QueryChatappPhoneNumbers', + 'QueryChatappBindWaba', + ], + ], + [ + 'id' => 389401, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SendChatappMassMessage', + 'SendChatappMessage', + 'WhatsappCall', + ], + ], + [ + 'id' => 389405, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateChatappTemplate', + 'ModifyChatappTemplate', + 'ListChatappTemplate', + 'GetChatappTemplateDetail', + 'DeleteChatappTemplate', + ], + ], + [ + 'id' => 389411, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListProductCatalog', + 'GetWhatsappConnectionCatalog', + 'ListProduct', + ], + ], + [ + 'id' => 389415, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetChatappPhoneNumberMetric', + 'EnableWhatsappROIMetric', + 'GetChatappTemplateMetric', + ], + ], + [ + 'id' => 389419, + 'title' => null, + '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' => 'Others', + 'type' => 'directory', + 'children' => [ + 'QueryMMLActive', + 'ListBindDmAccount', + 'UnbindDmAccount', + 'ListDmTag', + 'BindDmAccount', + 'ListDmAccount', + 'UpdateWabaMmlStatus', + 'GetChatFlowMetric', + 'ModifyChatappTemplateProperties', + 'ListPageAdAccount', + 'CreateMessengerPage', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AddChatGroup' => [ + 'summary' => 'AddChatGroup', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'UniqueCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '8938****', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '399s88-***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'AddChatGroupInviteLink' => [ + 'summary' => 'AddChatGroupInviteLink', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'WHATSAPP' => 'WHATSAPP', + ], + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'E93kdk****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3EIK939***', + ], + 'InviteLink' => [ + 'type' => 'string', + 'example' => 'https://chat.whatsapp.com/****', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteChatGroupInviteLink' => [ + 'summary' => 'DeleteChatGroupInviteLink', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'E398****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-8***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3R938***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Result' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + '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"}]', + ], + 'DeleteChatGroupParticipants' => [ + 'summary' => 'DeleteChatGroupParticipants', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8613800**', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP。'."\n", + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'EA93UU****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'List', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParticipantNumber' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'R39***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ListChatGroup' => [ + 'summary' => 'ListChatGroup', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + [ + 'name' => 'GroupStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + '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://aliyun.com/png.jpg', + ], + 'Subject' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'GroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EA30d***', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'UpdateChatGroup' => [ + 'summary' => 'UpdateChatGroup', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '8613800***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'https://aliyun.com/img.jpg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EA399***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'DeleteChatGroup' => [ + 'summary' => 'DeleteChatGroup', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'E399**', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E939E****', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-xi****', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2030***', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20399***', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'customAudience', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'TaskCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39ss**', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '238**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '244**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '233**', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'customAudience' => 'customAudience', + ], + 'example' => 'customAudience', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '233**', + ], + ], + [ + 'name' => 'PageKey', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '2ie**', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'ei**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '239***', + ], + 'TopicTitle' => [ + 'description' => 'The message\'s title', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'CustomAudienceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RecipientId' => [ + 'description' => 'The customer\'s Page-scoped ID (PSID)', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'TokenExpiryTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'CreationTimestamp' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'NotificationMessagesToken' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'NotificationMessagesReoptin' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'NextEligibleTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '172546854885', + ], + 'NotificationMessagesTimezone' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'UserTokenStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'NextPage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3399***', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '233**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '23**', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '238***', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'CampaignId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '233**', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '173029392838', + ], + 'AdAccountId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '3939**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '339**', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '239**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39**', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '69', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '239**', + ], + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'CustomAudienceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '339**', + ], + 'CustomAudienceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'custom audience name', + ], + 'TokenType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'custom', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'desc', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1720356898', + ], + 'AdAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '339**', + ], + 'UpdateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'TokenTotal' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '70', + ], + 'UploadType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'excel', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ListChatGroupParticipants' => [ + 'summary' => 'ListChatGroupParticipants', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'EA939****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'E9d9****', + ], + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '23***', + ], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 's39**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MarketingMessagesLinkBtnClick' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'DeleteMessageCampaign' => [ + 'summary' => '删除预算', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '293***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '293**', + ], + ], + [ + 'name' => 'CampaignId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '329**', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '239***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '238***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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', + 'required' => true, + 'example' => '300', + 'format' => 'int64', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'CampaignId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-***', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '239***', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '393**', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dd**', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '239**', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '3939**', + ], + ], + [ + 'name' => 'CustomAudienceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '[email protected]', + ], + 'Phone' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + 'required' => false, + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'EstimatedNumTotal', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '26', + ], + ], + [ + 'name' => 'BatchLastFlag', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39**', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '2992939*****', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'ins', + ], + 'ResourceRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2999292', + ], + 'InstanceDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'des', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'ChannelType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2399393****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3993939******', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"3993939******\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '11', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '2993*****', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CountryId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'ContactMail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ma**@gmail.com', + ], + 'ResourceRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '11', + ], + 'ResourceGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12', + ], + 'InstanceId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'dad-gf**', + ], + 'IsvTerms' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aa', + ], + 'FacebookBmId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '29kskkd******', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CountryId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '111', + ], + 'InstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '293939*****', + ], + 'OfficeAddress' => [ + 'description' => '', + 'type' => 'string', + 'example' => '长沙麓谷', + ], + 'SubmitTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '140092992', + ], + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'viber_ins', + ], + 'IsvTerms' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NULL', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ins', + ], + 'ResourceRegionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'InstanceId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'TriggerChatFlow' => [ + 'summary' => 'Trigger an Online ChatFlow', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => true, + 'example' => 'f4912c16943b4dfba44bd6fedacf8c70', + ], + ], + [ + 'name' => 'Data', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Input parameters in Key-Value format. The Key must match the input strategy configured at the start node of your flow.', + 'type' => 'object', + 'required' => false, + 'example' => '{"my_biz_data_0": "hi", "my_biz_data_1": "1024"}', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => 'Unique event ID used for idempotent triggers. Do not include any business semantics; you can retrieve this parameter within the flow after triggering.', + 'type' => 'string', + 'required' => false, + 'example' => 'c68622e6-5f0d-c8a4-af41-e949c2a7580e'."\n", + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'External system transaction number, used to associate with external business system transactions. You can retrieve this parameter within the flow after triggering.', + 'type' => 'string', + 'required' => false, + 'example' => '8d4acf7e-e360-eb83-6d74-fcf9c4538fda'."\n", + ], + ], + [ + 'name' => 'ClaimTimeMillis', + 'in' => 'query', + 'schema' => [ + 'description' => 'The declared occurrence time of the event, usually the time when the request was constructed, in milliseconds timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731502129000', + ], + ], + [ + 'name' => 'DiscardTimeMillis', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the event should be discarded, i.e., the expiration time. If this field is specified, the message will be discarded if it exceeds this time, in milliseconds timestamp.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1731502729000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial ', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error description message.', + 'type' => 'string', + 'example' => '无', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'example' => '{}', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '无', + ], + 'Success' => [ + 'description' => 'Whether the call was successful.'."\n" + .'- **true**: Call succeeded.'."\n" + .'- **false**: Call failed.', + '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' => 'Trigger an Online Flow', + 'description' => 'After triggering an online flow, if your flow contains components that incur costs for cloud products, such as message sending or function calls, please ensure you fully understand the billing methods and prices of the related products before using this interface.', + 'requestParamsDescription' => 'None.', + 'translator' => 'machine', + ], + 'CreateFlow' => [ + 'summary' => 'Creates a 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' => [ + 'title' => '', + 'description' => 'The name of the Flow.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'Categories', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The categories of the Flow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The category of the Flow.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SIGN_UP', + ], + 'required' => true, + 'minItems' => 1, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '93994848', + ], + ], + [ + 'name' => 'EndpointUri', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '333993838***', + ], + 'Categories' => [ + 'title' => '', + 'description' => 'The categories of the Flow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The category of the Flow.'."\n", + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'title' => '', + 'description' => 'The name of the Flow.'."\n", + 'type' => 'string', + 'example' => 'test1', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'CreateFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ListFlow' => [ + 'summary' => 'Queries a list of Flows.', + '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' => [ + 'title' => '', + 'description' => 'The name of the Flow that you want to query. If FlowName is left empty, the information about all Flows is queried.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The returned pages.'."\n", + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'title' => '', + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'Index' => [ + 'title' => '', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '99948484', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '3939393***', + ], + 'Categories' => [ + 'title' => '', + 'description' => 'The categories of the Flows.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The category of the Flow.'."\n", + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'title' => '', + 'description' => 'The Flow name.'."\n", + 'type' => 'string', + 'example' => 'flow-02020', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'ListFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetFlow' => [ + 'summary' => 'Queries the information about a 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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '99384883', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The state of the Flow.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* PUBLISHED'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* DRAFT'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* DEPRECATED'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'PUBLISHED' => 'PUBLISHED', + 'DRAFT' => 'DRAFT', + 'DEPRECATED' => 'DEPRECATED', + ], + 'example' => 'DRAFT', + ], + 'FlowId' => [ + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => 'flow_id_arms', + ], + 'PreviewUrl' => [ + 'description' => 'The temporary preview URL.'."\n", + 'type' => 'string', + 'example' => 'https://pre-url', + ], + 'EndpointUri' => [ + 'type' => 'string', + 'example' => 'http://abc.com', + ], + 'JSONVersion' => [ + 'description' => 'The JSON version.'."\n", + 'type' => 'string', + 'example' => '2.1', + ], + 'Categories' => [ + 'description' => 'The categories of the Flow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The category of the Flow.'."\n", + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'description' => 'The Flow name.'."\n", + 'type' => 'string', + 'example' => 'dnjn', + ], + 'DataApiVersion' => [ + 'description' => 'The version number of the API.'."\n", + 'type' => 'string', + 'example' => '3.0', + ], + 'PreviewUrlExpires' => [ + 'description' => 'The time when the preview URL expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700617436633'."\n", + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'GetFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'SyncFlow' => [ + 'summary' => '同步flow', + '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' => '', + 'type' => 'string', + 'example' => '172D586A-5E9D-11C8-BED3-7E4A0***', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ModifyFlow' => [ + 'summary' => 'Modifies the basic information about a 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' => [ + 'title' => '', + 'description' => 'The name of the Flow.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'Categories', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The information about the categories of the Flow.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The category of the Flow.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* CUSTOMER_SUPPORT'."\n" + .'* OTHER'."\n" + .'* SIGN_IN'."\n" + .'* SIGN_UP'."\n" + .'* APPOINTMENT_BOOKING'."\n" + .'* LEAD_GENERATION'."\n" + .'* SURVEY'."\n" + .'* CONTACT_US'."\n", + '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, + 'minItems' => 1, + 'example' => '', + ], + ], + [ + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2938838', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9493884', + ], + ], + [ + 'name' => 'EndpointUri', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.***.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D******', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '3939399****', + ], + 'EndpointUri' => [ + 'type' => 'string', + 'example' => 'http://www.abc.com', + ], + 'Categories' => [ + 'title' => '', + 'description' => 'The categories of the Flow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The category of the Flow.'."\n", + 'type' => 'string', + 'example' => 'SIGN_UP', + ], + 'example' => '', + ], + 'FlowName' => [ + 'title' => '', + 'description' => 'The Flow name.'."\n", + 'type' => 'string', + 'example' => 'flow-00203', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'ModifyFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'UpdateFlowJSONAsset' => [ + 'summary' => 'Updates a Flow by using JSON content.', + '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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'FilePath', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'JSON file generated according to Facebook flow rules.', + 'type' => 'string', + 'required' => true, + 'example' => 'https://aliyun/json.json', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'SpaceId/instance ID of ISV sub customer.', + 'type' => 'string', + 'required' => false, + 'example' => '9399393', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => ' '."\n" + .'90E63D28-E31D-1EB2-8939-A9486641****'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '84848847****', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The result returns OK as normal.', + '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' => 'UpdateFlowJSONAsset', + ], + 'GetFlowJSONAssest' => [ + 'summary' => 'Queries the JSON content of a Flow.', + '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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '83883873', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => 'flow_id_arms', + ], + 'FilePath' => [ + 'description' => 'The file path.'."\n", + 'type' => 'string', + 'example' => 'https://url.com/json.json', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.', + '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' => 'GetFlowJSONAssest', + ], + 'GetFlowPreviewUrl' => [ + 'summary' => 'Obtains the preview URL of a Flow.', + '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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '939399383', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowId' => [ + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '6dd31e1b7cc940fc99e293d9952b5b79', + ], + 'PreviewUrl' => [ + 'description' => 'The temporary preview URL.'."\n", + 'type' => 'string', + 'example' => 'https://url', + ], + 'PreviewUrlExpires' => [ + 'description' => 'The time when the preview URL expires. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1700617436633', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'GetFlowPreviewUrl', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'PublishFlow' => [ + 'summary' => 'Publishes a 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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'PublishFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DeprecateFlow' => [ + 'summary' => 'Deprecates a 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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '38877483', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The result returns OK as normal.', + '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' => 'DeprecateFlow', + ], + 'DeleteFlow' => [ + 'summary' => 'Deletes a Flow. Only Flows in the DRAFT state can be deleted.', + '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' => [ + 'title' => '', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '393983883', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'DeleteFlow', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'IsvGetAppId' => [ + 'summary' => 'Obtains the application ID under the ISV account.', + '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' => [ + 'title' => '', + 'description' => 'The type of the app. Valid value: WHATSAPP.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'IntlVersion', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + 'default' => '2', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The permission.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* whatsapp_business_messaging: sending permission on WhatsApp messages'."\n" + .'* ads_management: management permission on advertisements'."\n" + .'* catalog_management: management permission on catalogs'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'whatsapp_business_messaging' => '', + 'ads_management' => '', + 'catalog_management' => '', + ], + 'example' => 'catalog_management', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3***', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'null', + ], + 'AppId' => [ + 'title' => '', + 'description' => 'The message ID.'."\n", + 'type' => 'string', + 'example' => '23hr3v', + ], + 'ConfigId' => [ + 'description' => 'The ID of the configuration item.'."\n", + 'type' => 'string', + 'example' => '28972951817****', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'IsvGetAppId', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ChatappBindWaba' => [ + 'summary' => 'Binds the WhatsApp Business account with ChatApp.', + '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' => 'The ID of the WhatsApp Business account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2293938222343****', + 'title' => 'WabaId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustSpaceId' => [ + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'example' => 'C02029392939939', + 'title' => '', + ], + 'WabaId' => [ + 'description' => 'The ID of the WhatsApp Business Account (WABA).'."\n", + 'type' => 'string', + 'example' => '2939828282', + 'title' => 'wabaId', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ChatappBindWaba', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetPermissionByCode' => [ + 'summary' => 'Obtains permissions based on the authorization code obtained from embedded signup.', + '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' => [ + 'title' => '', + 'description' => 'Authorize code information.', + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '393847477', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The permissions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The permission.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ads_management'."\n" + .'* catalog_management'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ads_management' => 'ads_management', + 'catalog_management' => 'catalog_management', + ], + 'example' => 'catalog_management', + ], + 'required' => false, + 'minItems' => 1, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~196974~~).'."\n", + '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' => 'GetPermissionByCode', + ], + 'ChatappSyncPhoneNumber' => [ + 'summary' => 'Synchronizes phone numbers.', + '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' => 'The space ID of the user under the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'PhoneNumbers' => [ + 'description' => 'The phone numbers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object.'."\n", + 'type' => 'object', + 'properties' => [ + 'VerifiedName' => [ + 'description' => 'The display name of the business to which the phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'Alibaba', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The state of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MIGRATED'."\n" + .'* FLAGGED'."\n" + .'* DISCONNECTED'."\n" + .'* UNVERIFIED'."\n" + .'* BANNED'."\n" + .'* RATE_LIMITED'."\n" + .'* PENDING'."\n" + .'* CONNECTED'."\n" + .'* UNKNOWN'."\n" + .'* DELETED'."\n" + .'* RESTRICTED'."\n", + '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', + 'title' => '', + ], + 'UpQueue' => [ + 'description' => 'The mobile originated (MO) message queue.'."\n", + 'type' => 'string', + 'example' => 'alicom-09399200-queue', + 'title' => '', + ], + 'NameStatus' => [ + 'description' => 'The review status of the business display name.'."\n", + 'type' => 'string', + 'example' => 'Approval', + 'title' => '', + ], + 'MessagingLimitTier' => [ + 'description' => 'The number of phone numbers to which messages can be sent in a day.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TIER_100K' => '100000', + 'TIER_UNLIMITED' => 'unlimited', + 'TIER_250' => '250', + 'TIER_1K' => '1000', + 'TIER_50' => '50', + 'TIER_10K' => '10000', + ], + 'example' => 'TIER_10', + 'title' => '', + ], + 'StatusCallbackUrl' => [ + 'description' => 'The callback URL to which status reports are sent by using HTTP callbacks.'."\n", + 'type' => 'string', + 'example' => 'https://www.alibaba.com/status', + 'title' => '', + ], + 'QualityRating' => [ + 'description' => 'The quality rating of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RED'."\n" + .'* YELLOW'."\n" + .'* GREEN'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RED' => 'RED', + 'YELLOW' => 'YELLOW', + 'GREEN' => 'GREEN', + ], + 'example' => 'GREEN', + 'title' => '', + ], + 'CodeVerificationStatus' => [ + 'description' => 'The verification state of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* REVOKED: The review application is revoked.'."\n" + .'* MORE_INFORMATION_REQUESTED: More information needs to be provided.'."\n" + .'* VERIFIED: The phone number passes the verification.'."\n" + .'* REJECTED: The phone number fails to pass the verification.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'REVOKED' => '', + 'MORE_INFORMATION_REQUESTED' => '', + 'VERIFIED' => '', + 'REJECTED' => '', + ], + 'example' => 'VERIFIED', + 'title' => '', + ], + 'NewNameStatus' => [ + 'description' => 'The review status of the new business display name.'."\n", + 'type' => 'string', + 'example' => 'Approval', + 'title' => '', + ], + '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' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613800001234', + 'title' => '', + ], + 'StatusQueue' => [ + 'description' => 'The status report queue.'."\n", + 'type' => 'string', + 'example' => 'alicom-09399200-queue', + 'title' => '', + ], + 'IsOfficial' => [ + 'description' => 'Indicates whether it is a WhatsApp Official Business Account (OBA).'."\n", + 'type' => 'string', + 'example' => 'N', + ], + 'UpCallbackUrl' => [ + 'description' => 'The URL that receives the MO messages.'."\n", + 'type' => 'string', + 'example' => 'https://www.alibaba.com/inbound'."\n", + 'title' => '', + ], + ], + ], + 'example' => '', + 'title' => '', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'* **true**: The call was successful.'."\n" + .'* **false**: The call failed.'."\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', + ], + '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' => 'ChatappSyncPhoneNumber', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'AddChatappPhoneNumber' => [ + 'summary' => 'Adds a phone number for a WhatsApp Business account (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' => 'AddChatappPhoneNumber', + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Adds a phone number for a WhatsApp Business account (WABA).', + 'type' => 'string', + 'required' => true, + 'example' => '93928389****', + ], + ], + [ + 'name' => 'Cc', + 'in' => 'query', + 'schema' => [ + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '86', + ], + ], + [ + 'name' => 'PreValidateId', + 'in' => 'query', + 'schema' => [ + 'description' => 'cams:ChatappPhoneNumberRegister', + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '1020****', + ], + ], + [ + 'name' => 'VerifiedName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Private', + 'type' => 'string', + 'required' => true, + 'example' => 'Alibaba', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'alicom-access-oxs', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'com.alicom.access.oxs.client.channel.aliyun.flow.AyFlowExecuteService', + 'type' => 'string', + 'example' => 'http://pop_access_slb_sgvpc/#vpc', + ], + 'Message' => [ + 'description' => 'com.alicom.access.oxs.client.channel.aliyun.flow.dto.AyCommonApiRequest', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'formData', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '13800000000', + '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' => 'AddChatappPhoneNumber', + ], + 'GetPhoneNumberVerificationStatus' => [ + 'summary' => 'Obtains the verification status of a phone number.', + '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' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613900001234', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user under the ISV account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '229393838****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'CodeVerificationStatus' => [ + 'title' => '', + 'description' => 'The verification status.'."\n", + 'type' => 'string', + 'example' => 'VERIFIED', + ], + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613900001234', + ], + 'Id' => [ + 'title' => '', + 'description' => 'The ID of the number.'."\n", + 'type' => 'string', + 'example' => '2224342624', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'GetPhoneNumberVerificationStatus', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetChatappVerifyCode' => [ + 'summary' => 'Obtains a verification code.', + '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' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + 'title' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '229393838*****', + 'title' => '', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => 'The verification method.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Voice: sends the verification code via phone call.'."\n" + .'* sms: sends the verification code via SMS.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'voice' => '', + 'sms' => '', + ], + 'example' => 'SMS', + 'title' => '', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'* **true**: The call was successful.'."\n" + .'* **false**: The call failed.'."\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.', + ], + ], + ], + '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' => 'GetChatappVerifyCode', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ChatappVerifyAndRegister' => [ + 'summary' => 'Associates a phone number with a WhatsApp Business account (WABA).', + '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' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '29389299388383', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + 'title' => '', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The verification code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '223222', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'* **true**: The call was successful.'."\n" + .'* **false**: The call failed.'."\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.', + ], + ], + ], + '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' => 'ChatappVerifyAndRegister', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ChatappPhoneNumberRegister' => [ + 'summary' => 'Registers a phone number.', + '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' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + 'title' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user under the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '939283893939***', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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.', + ], + ], + ], + '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' => 'ChatappPhoneNumberRegister', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ChatappPhoneNumberDeregister' => [ + 'summary' => 'Deregisters a phone number from a WhatsApp Business account (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' => [ + 'title' => '', + 'description' => 'The phone number that you want to deregister.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800000000', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '939283893939', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'ChatappPhoneNumberDeregister', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'QueryWabaBusinessInfo' => [ + 'summary' => 'Queries the business information about the WhatsApp Business account (WABA).', + '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' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + 'title' => '', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WhatsApp Business Account (WABA).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293848822333', + 'title' => 'wabaId', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None.'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'The business information about the WABA.'."\n", + 'type' => 'object', + 'properties' => [ + 'Vertical' => [ + 'description' => 'The industry.'."\n", + 'type' => 'string', + 'example' => 'Retail'."\n", + 'title' => '', + 'deprecated' => true, + ], + 'VerificationStatus' => [ + 'description' => 'The verification status.'."\n", + 'type' => 'string', + 'example' => 'verified', + 'title' => '', + ], + 'BusinessName' => [ + 'description' => 'The Business Manager name.'."\n", + 'type' => 'string', + 'example' => 'Alibaba', + 'title' => '', + ], + 'BusinessId' => [ + 'description' => 'The Business Manager ID.'."\n", + 'type' => 'string', + 'example' => '192882828733', + 'title' => '', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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.', + ], + ], + ], + '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' => 'QueryWabaBusinessInfo', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'UpdatePhoneWebhook' => [ + 'summary' => 'The HTTP status code returned.'."\n" + ."\n" + .'\\* A value of OK indicates that the call is successful.'."\n" + .'\\* Other values indicate that the call fails. For more information, see \\[Error codes]\\(~~196974~~).', + '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' => [ + 'title' => '', + 'description' => 'SpaceId for ISV sub clients.', + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + [ + 'name' => 'HttpFlag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Whether to use HTTP to receive receipts. Value:'."\n" + .'* Y: Yes.'."\n" + .'* N: No.', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'QueueFlag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Whether to use queue method to receive receipts. Value:'."\n" + .'* Y: Yes.'."\n" + .'* N: No.', + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'phone number.', + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + ], + ], + [ + 'name' => 'StatusCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'HTTP status report interface callback address.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'UpCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'HTTP upstream message interface callback address.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://aliyun.com', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied for detailed information.', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Prompt message, there is a value when an exception is returned.', + 'type' => 'string', + 'example' => 'null', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'UpdatePhoneWebhook', + 'description' => 'The error message returned.'."\n", + ], + 'UpdateAccountWebhook' => [ + 'summary' => 'Modifies the callback URL of an account.', + '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' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493**', + ], + ], + [ + 'name' => 'StatusCallbackUrl', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The callback URL to which status reports are sent by using HTTP callbacks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com', + ], + ], + [ + 'name' => 'HttpFlag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to use HTTP callbacks to receive message receipts. Valid values:'."\n" + ."\n" + .'* Y: indicates that HTTP callbacks are used to receive receipts.'."\n" + .'* N: indicates that HTTP callbacks are not used to receive receipts.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'QueueFlag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies whether to use Message Service (MNS) queues to receive receipts. Valid values:'."\n" + ."\n" + .'* Y: indicates that MNS queues are used to receive receipts.'."\n" + .'* N: indicates that MNS queues are not used to receive receipts.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'N', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'UpdateAccountWebhook', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'QueryPhoneBusinessProfile' => [ + 'summary' => 'Queries the business information of the account to which a specified phone number is bound.', + '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' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2934839388494***', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Vertical' => [ + 'description' => 'The industry.'."\n", + 'type' => 'string', + 'example' => 'Retail'."\n", + 'title' => '', + ], + 'Description' => [ + 'description' => 'The description.'."\n", + 'type' => 'string', + 'example' => 'Description'."\n", + 'title' => '', + ], + 'Email' => [ + 'description' => 'The email address.'."\n", + 'type' => 'string', + 'example' => '[email protected]', + 'title' => '', + ], + 'Address' => [ + 'description' => 'The address.'."\n", + 'type' => 'string', + 'example' => 'Changsha'."\n", + 'title' => '', + ], + 'ProfilePictureUrl' => [ + 'description' => 'The profile picture.'."\n", + 'type' => 'string', + 'example' => 'https://....img', + 'title' => '', + ], + 'Websites' => [ + 'description' => 'The website.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The website URL.'."\n", + 'type' => 'string', + 'example' => 'https://alibaba.com', + ], + 'example' => '', + 'title' => '', + ], + 'About' => [ + 'description' => 'Regarding.', + 'type' => 'string', + 'example' => 'business profile', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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 \\"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' => 'QueryPhoneBusinessProfile', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyPhoneBusinessProfile' => [ + 'summary' => 'The ID of the request.', + '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' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849****', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + 'title' => '', + ], + ], + [ + 'name' => 'Address', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The phone number.'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + 'title' => '', + ], + ], + [ + 'name' => 'Vertical', + 'in' => 'query', + 'schema' => [ + 'description' => 'The industry.'."\n" + ."\n" + .'> Valid values: OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, and RESTAURANT.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RETAIL' => 'RETAIL', + 'TRAVEL' => 'TRAVEL', + 'PROF_SERVICES' => 'PROF_SERVICES', + 'APPAREL' => 'APPAREL', + 'GOVT' => 'GOVT', + 'ENTERTAIN' => 'ENTERTAIN', + 'GROCERY' => 'GROCERY', + 'HOTEL' => 'HOTEL', + 'OTHER' => 'OTHER', + 'AUTO' => 'AUTO', + 'FINANCE' => 'FINANCE', + 'BEAUTY' => 'BEAUTY', + 'EDU' => 'EDU', + 'EVENT_PLAN' => 'EVENT_PLAN', + 'NONPROFIT' => 'NONPROFIT', + 'RESTAURANT' => 'RESTAURANT', + 'HEALTH' => 'HEALTH', + ], + 'example' => 'OTHER', + 'title' => '', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => 'The email address.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + 'title' => '', + ], + ], + [ + 'name' => 'ProfilePictureUrl', + 'in' => 'query', + 'schema' => [ + 'description' => 'The URL of the profile picture.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'http://a.img', + 'title' => '', + ], + ], + [ + 'name' => 'Websites', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The URLs of the websites.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The URL of the website.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com', + ], + 'required' => false, + 'example' => '', + 'title' => '', + ], + ], + [ + 'name' => 'About', + 'in' => 'query', + 'schema' => [ + 'description' => 'The business information.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'business profile', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => 'The websites.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => 'The URL of the website.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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 \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ModifyPhoneBusinessProfile', + 'description' => 'ModifyPhoneBusinessProfile', + ], + 'CreateChatappMigrationInitiate' => [ + 'summary' => 'The ID of the number.', + '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' => [ + 'title' => '', + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493****', + ], + ], + [ + 'name' => 'MobileNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The mobile number without the country code or region code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '13900001234', + ], + ], + [ + 'name' => 'CountryCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The code of the country or region.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '86', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The information about the request denial..'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => 'The response data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '', + 'description' => 'The state of the mobile number. Only MIGRATING may be returned, which indicates that the mobile number is being migrated.'."\n", + 'type' => 'string', + 'example' => 'MIGRATING', + ], + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'The mobile number.'."\n", + 'type' => 'string', + 'example' => '8613900001234', + ], + 'Id' => [ + 'title' => '', + 'description' => 'The ID of the mobile number.'."\n", + 'type' => 'string', + 'example' => '82828893332', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* A value of OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~196974~~).'."\n", + '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' => 'CreateChatappMigrationInitiate', + 'description' => 'The status of the phone number.'."\n", + ], + 'GetMigrationVerifyCode' => [ + 'summary' => 'Obtain the verification code for the migration number.', + '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' => [ + 'title' => '', + 'description' => 'The space ID of the user under the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Phone number.', + 'type' => 'string', + 'required' => true, + 'example' => '8613800001234', + ], + ], + [ + 'name' => 'Locale', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The language.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The method to obtain the verification code. Valid values: SMS and VOICE.'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'voice' => 'voice', + 'sms' => 'sms', + ], + 'example' => 'sms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'Phone number.', + 'type' => 'string', + 'example' => '8613800001234', + ], + 'Id' => [ + 'title' => '', + 'description' => 'The ID of the number.'."\n", + 'type' => 'string', + 'example' => '82828893332', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'GetMigrationVerifyCode', + 'description' => 'The single user QPS limit for this interface is 10 times per second. Exceeding the limit may result in restricted API calls, which may affect your business. Please make reasonable calls.', + ], + 'ChatappMigrationVerified' => [ + 'summary' => 'Verifies a specified phone number for migration.', + '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' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861380001234', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The verification code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '828798', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613800001234', + ], + 'Id' => [ + 'title' => '', + 'description' => 'The ID of the phone number.'."\n", + 'type' => 'string', + 'example' => '82828893332', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'ChatappMigrationVerified', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ChatappMigrationRegister' => [ + 'summary' => 'Registers a phone number for migration.', + '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' => [ + 'title' => 'The details about the access denial.'."\n", + 'description' => 'None'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '29348393884****', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'phone number.', + 'type' => 'string', + 'required' => true, + 'example' => '8613800****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Return data.', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'ChatappMigrationRegister', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + ], + 'GetChatappUploadAuthorization' => [ + 'summary' => 'Obtains the authentication information that is used to upload a file.', + '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' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied for detailed information.', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'SecurityToken' => [ + 'title' => '', + 'description' => 'The security token.'."\n", + 'type' => 'string', + 'example' => 'dkdieiii**', + ], + 'Expire' => [ + 'title' => '', + 'description' => 'The timeout period.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3600', + ], + 'BucketName' => [ + 'title' => '', + 'description' => 'The name of the bucket to which a file is uploaded in OSS.'."\n", + 'type' => 'string', + 'example' => 'oss', + ], + 'AccessKeyId' => [ + 'title' => '', + 'description' => 'The AccessKey ID that is used to authorize a user to upload a file to Object Storage Service (OSS).'."\n", + 'type' => 'string', + 'example' => '2skeuurfj****', + ], + 'AccessKeySecret' => [ + 'title' => '', + 'description' => 'The AccessKey secret that is used to authorize a user to upload a file to OSS.'."\n", + 'type' => 'string', + 'example' => 'skdkdukeuuuu****', + ], + 'EndPoint' => [ + 'title' => '', + 'description' => 'The address of the OSS server to which a file is uploaded.'."\n", + 'type' => 'string', + 'example' => 'https://oss.com', + ], + 'Dir' => [ + 'title' => '', + 'description' => 'The directory to which the file is uploaded in Object Storage Service (OSS).'."\n", + 'type' => 'string', + 'example' => '1000102939', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'GetChatappUploadAuthorization', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetCommerceSetting' => [ + 'summary' => 'Queries the business settings of a phone number.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied for detailed information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + 'title' => 'Id of the request', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CartEnable' => [ + 'description' => 'Indicates whether the shopping cart button is displayed. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + 'CatalogVisible' => [ + 'description' => 'Indicates whether the catalog button is displayed. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + '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' => 'GetCommerceSetting', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'UpdateCommerceSetting' => [ + 'summary' => 'Modifies the business settings of a phone number.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '293483938849493', + 'title' => '', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1380000****', + 'title' => '', + ], + ], + [ + 'name' => 'CartEnable', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display the shopping cart button. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + 'title' => '', + ], + ], + [ + 'name' => 'CatalogVisible', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to display the catalog button. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'false', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + 'title' => 'Id of the request', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'title' => 'Schema of Response', + ], + ], + ], + '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' => 'UpdateCommerceSetting', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetWhatsappHealthStatus' => [ + 'summary' => 'Queries the messaging health status of different types of nodes.', + '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' => 'The node type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* template: message template'."\n" + .'* phone: phone number'."\n" + .'* waba: WhatsApp Business Account (WABA)'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'template' => 'template', + 'phone' => 'phone', + 'waba' => 'waba', + ], + 'example' => 'waba', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the enterprise.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '399299***', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template language.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WabaId'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '299399****', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2993****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'CanSendMessage' => [ + 'description' => 'Indicates whether the messages can be sent.'."\n", + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'Entities' => [ + 'description' => 'The queried entities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried entity.'."\n", + 'type' => 'object', + 'properties' => [ + 'EntityType' => [ + 'description' => 'The entity type.'."\n", + 'type' => 'string', + 'example' => 'PHONE_NUMBER', + ], + 'TemplateCode' => [ + 'description' => 'The template code. This parameter is returned when the NodeType parameter is set to **template**.'."\n", + 'type' => 'string', + 'example' => '939928****', + ], + 'Errors' => [ + 'description' => 'The reasons why the messages failed to be sent.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The reason why the messages failed to be sent.'."\n", + 'type' => 'object', + 'properties' => [ + 'ErrorDescription' => [ + 'description' => 'The description of the error.'."\n", + 'type' => 'string', + 'example' => 'There is an error with the payment method.', + ], + 'PossibleSolution' => [ + 'description' => 'The possible solution to the error.'."\n", + 'type' => 'string', + 'example' => 'There was an error with your payment method. Please add a new payment method to the account.', + ], + 'ErrorCode' => [ + 'description' => 'The error code.'."\n", + 'type' => 'string', + 'example' => '141006', + ], + ], + ], + 'example' => '', + ], + 'Language' => [ + 'description' => 'The template language.'."\n", + 'type' => 'string', + 'example' => 'en', + ], + 'CanSendMessage' => [ + 'description' => 'Indicates whether the messages can be sent.'."\n", + 'type' => 'string', + 'example' => 'AVAILABLE', + ], + 'PhoneNumber' => [ + 'description' => 'The phone number to which the messages are sent.'."\n", + 'type' => 'string', + 'example' => '86138****', + ], + 'WabaId' => [ + 'description' => 'The WABA ID. You can view the WABA ID in the Chat App Message Service console after you create the WABA.'."\n", + 'type' => 'string', + 'example' => '39939***', + ], + 'BusinessId' => [ + 'description' => 'The Business Manager ID.'."\n", + 'type' => 'string', + 'example' => '3992****', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~196974~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + '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' => 'Get Whatsapp message send health status', + 'description' => '### [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'This operation will directly obtain data from Facebook, which sets an upper limit on the total number of calls for operations. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'UpdateConversationalAutomation' => [ + 'summary' => 'Modifies welcoming messages, opening remarks, and commands for a phone number.', + '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' => 'Specifies whether to enable the welcoming message.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the enterprise.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '86130000***', + ], + ], + [ + 'name' => 'Commands', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The command.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommandDescription' => [ + 'description' => 'The description of the command.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Command 1.', + ], + 'CommandName' => [ + 'description' => 'The command name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Prompts', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The opening remarks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The opening remark.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'prompt1', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '2993****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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' => 'Change the number welcome message, opening remarks, and commands', + 'description' => '### [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'This operation will directly obtain data from Facebook, which sets an upper limit on the total number of calls for operations. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetConversationalAutomation' => [ + 'summary' => 'Configures welcoming messages, opening remarks, and commands.', + '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' => 'The space ID of the RAM user within the independent software vendor (ISV) account or the instance ID of the customer of Alibaba Cloud.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cams-3ie***', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The phone number of the enterprise.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '86130000***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Prompts' => [ + 'description' => 'The opening remarks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The opening remark.'."\n", + 'type' => 'string', + 'example' => 'prompt1', + ], + 'example' => '', + ], + 'Commands' => [ + 'description' => 'The commands.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The command.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommandDescription' => [ + 'description' => 'The description of the command.'."\n", + 'type' => 'string', + 'example' => 'description', + ], + 'CommandName' => [ + 'description' => 'The name of the command.'."\n", + 'type' => 'string', + 'example' => 'common1', + ], + ], + ], + 'example' => '', + ], + 'PhoneNumber' => [ + 'description' => 'The phone number of the enterprise.'."\n", + 'type' => 'string', + 'example' => '86138****', + ], + 'EnableWelcomeMessage' => [ + 'description' => 'Indicates whether the welcoming message is enabled.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\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 \\"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' => 'Get number welcome messages, opening remarks, and commands', + 'description' => '### [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'This operation will directly obtain data from Facebook, which sets an upper limit on the total number of calls for operations. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetPhoneEncryptionPublicKey' => [ + 'summary' => 'Queries the encryption public key of a phone number.', + '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' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'flow_001', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user under the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '393838848', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'EncryptionPublicKey' => [ + 'description' => 'The public key.'."\n", + 'type' => 'string', + 'example' => '-----BEGIN PUBLIC KEY-----'."\n" + .'AAA'."\n" + .'BBB'."\n" + .'CCC'."\n" + .'DDD'."\n" + .'EEE'."\n" + .'FFF'."\n" + .'GGG'."\n" + .'-----END PUBLIC KEY-----', + ], + 'PhoneNumber' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '86138000**', + ], + 'EncryptionPublicKeyStatus' => [ + 'description' => 'The validity state of the public key. Valid values:'."\n" + ."\n" + .'* MISMATCH: The public key is invalid.'."\n" + .'* VALID: The public key is valid.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'VALID', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~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' => 'Obtain the encrypted public key of the number', + ], + 'UpdatePhoneEncryptionPublicKey' => [ + 'summary' => 'Updates the encryption public key of a phone number.', + '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' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '86138000', + ], + ], + [ + 'name' => 'EncryptionPublicKey', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Encrypt the public key.', + 'type' => 'string', + 'required' => true, + 'example' => '-----BEGIN PUBLIC KEY-----'."\n" + .'AAA'."\n" + .'BBB'."\n" + .'CCC'."\n" + .'DDD'."\n" + .'EEE'."\n" + .'FFF'."\n" + .'GGG'."\n" + .'-----END PUBLIC KEY-----', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'SpaceId/instanceId of ISV sub clients.', + 'type' => 'string', + 'required' => false, + 'example' => '399382882', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The result returns OK as normal.', + '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' => 'Update the encrypted public key of the number', + ], + 'UpdatePhoneMessageQrdl' => [ + 'summary' => 'Modifies a quick-response (QR) code that contains a message.', + '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' => [ + 'title' => '', + 'description' => 'Number, enter the country/region code+number.', + 'type' => 'string', + 'required' => true, + 'example' => '861380000', + ], + ], + [ + 'name' => 'GenerateQrImage', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Produce QR code image format.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SVG' => 'SVG', + 'PNG' => 'PNG', + ], + 'example' => 'PNG', + ], + ], + [ + 'name' => 'PrefilledMessage', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Message content.', + 'type' => 'string', + 'required' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'QrdlCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'QR code encoding.', + 'type' => 'string', + 'required' => true, + 'example' => '29338838', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'SpaceId/instance ID of ISV sub customer.', + 'type' => 'string', + 'required' => false, + 'example' => '9383884', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D******', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'title' => '', + 'description' => 'QR code address.', + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'Number.', + 'type' => 'string', + 'example' => '8613800', + ], + 'QrdlCode' => [ + 'title' => '', + 'description' => 'QR code encoding.', + 'type' => 'string', + 'example' => 'DEDEE998', + ], + 'DeepLinkUrl' => [ + 'title' => '', + 'description' => 'Deep link address.', + 'type' => 'string', + 'example' => 'https://wa.msg/', + ], + 'GenerateQrImage' => [ + 'title' => '', + 'description' => 'Generate image types.', + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'title' => '', + 'description' => 'Message content.', + 'type' => 'string', + 'example' => 'Hello', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The result returns OK as normal.', + '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' => 'Modify message QR code', + ], + 'ListPhoneMessageQrdl' => [ + 'summary' => 'Queries the information about a list of quick-response (QR) codes that contain messages.', + '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' => [ + 'title' => '', + 'description' => 'The phone number. Add the country code before the phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861380000', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9383883', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'title' => '', + 'description' => 'Error description information.', + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'description' => 'The URL of the QR code.'."\n", + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'PhoneNumber' => [ + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613800', + ], + 'QrdlCode' => [ + 'description' => 'The mode of the quick-response (QR) code.'."\n", + 'type' => 'string', + 'example' => 'IUIED999', + ], + 'DeepLinkUrl' => [ + 'description' => 'The URL of the deep link.'."\n", + 'type' => 'string', + 'example' => 'https://wa.msg/', + ], + 'GenerateQrImage' => [ + 'description' => 'The format of the generated image.'."\n", + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'description' => 'The message content.'."\n", + 'type' => 'string', + 'example' => 'Hello', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'Query message QR code list', + ], + 'DeletePhoneMessageQrdl' => [ + 'summary' => 'Deletes a quick-response (QR) code that contains a message.', + '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' => [ + 'title' => '', + 'description' => 'The phone number. Add the country code before the phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861380000', + ], + ], + [ + 'name' => 'QrdlCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'QR code encoding.', + 'type' => 'string', + 'required' => true, + 'example' => '29338838', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '883873773', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'Delete message QR code', + ], + 'CreatePhoneMessageQrdl' => [ + 'summary' => 'Creates a quick-response (QR) code that contains a message.', + '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' => [ + 'title' => '', + 'description' => 'The phone number. Add the country code before the phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861380000', + ], + ], + [ + 'name' => 'GenerateQrImage', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Produce QR code image format.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'SVG' => 'SVG', + 'PNG' => 'PNG', + ], + 'example' => 'PNG', + ], + ], + [ + 'name' => 'PrefilledMessage', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Message content.', + 'type' => 'string', + 'required' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '838833', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'none', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'QrImageUrl' => [ + 'title' => '', + 'description' => 'The URL of the QR code.'."\n", + 'type' => 'string', + 'example' => 'http://img.png', + ], + 'PhoneNumber' => [ + 'title' => '', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613800', + ], + 'QrdlCode' => [ + 'title' => '', + 'description' => 'The mode of the quick-response (QR) code.'."\n", + 'type' => 'string', + 'example' => 'D9II3***', + ], + 'DeepLinkUrl' => [ + 'title' => '', + 'description' => 'The URL of the deep link.'."\n", + 'type' => 'string', + 'example' => 'https://wa.qrdl/', + ], + 'GenerateQrImage' => [ + 'title' => '', + 'description' => 'The format of the generated image.'."\n", + 'type' => 'string', + 'example' => 'PNG', + ], + 'PrefilledMessage' => [ + 'title' => '', + 'description' => 'The message content.'."\n", + 'type' => 'string', + 'example' => 'Hello', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'If OK is returned, the request was successful.'."\n", + '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' => 'Create message QR code', + ], + 'QueryChatappPhoneNumbers' => [ + 'summary' => 'Queries phone numbers that receive messages and statuses of these numbers under a specified user.', + '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' => 'The independent software vendor (ISV) verification code, which is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aksik93kdkkxmwol93939', + 'title' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + 'title' => '', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'The state of the phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'VERIFIED', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The results returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumbers' => [ + 'description' => 'The phone numbers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The phone numbers.'."\n", + 'type' => 'object', + 'properties' => [ + 'VerifiedName' => [ + 'description' => 'The display name of the enterprise to which the phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'Alibaba', + 'title' => '', + ], + 'Status' => [ + 'description' => 'The state of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* MIGRATED'."\n" + .'* FLAGGED'."\n" + .'* DISCONNECTED'."\n" + .'* UNVERIFIED'."\n" + .'* BANNED'."\n" + .'* RATE_LIMITED'."\n" + .'* PENDING'."\n" + .'* CONNECTED'."\n" + .'* UNKNOWN'."\n" + .'* DELETED'."\n" + .'* RESTRICTED'."\n", + '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' => 'CONNECTED', + 'title' => '', + ], + 'UpQueue' => [ + 'description' => 'The mobile originated (MO) message queue.'."\n", + 'type' => 'string', + 'example' => 'Alicom-Queue-****-ChatAppInbound', + 'title' => '', + ], + 'NameStatus' => [ + 'description' => 'The review status of the name.'."\n", + 'type' => 'string', + 'example' => 'Approval', + 'title' => '', + ], + 'MessagingLimitTier' => [ + 'description' => 'The number of phone numbers to which messages can be sent in a day.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TIER\\_100K: 100,000'."\n" + .'* TIER_UNLIMITED: unlimited'."\n" + .'* TIER\\_250: 250'."\n" + .'* TIER\\_1K: 1,000'."\n" + .'* TIER\\_50: 50'."\n" + .'* TIER\\_10K: 10,000'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'TIER_100K' => '100000', + 'TIER_UNLIMITED' => 'unlimited', + 'TIER_250' => '250', + 'TIER_1K' => '1000', + 'TIER_50' => '50', + 'TIER_10K' => '10000', + ], + 'example' => 'TIER_10', + 'title' => '', + ], + 'StatusCallbackUrl' => [ + 'description' => 'The URL that receives the status reports.'."\n", + 'type' => 'string', + 'example' => 'https://ali.com/status', + 'title' => '', + ], + 'QualityRating' => [ + 'description' => 'The quality rating of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RED: low'."\n" + .'* YELLOW: medium'."\n" + .'* UNKNOWN: unknown'."\n" + .'* GREEN: high'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'RED' => 'RED', + 'YELLOW' => 'YELLOW', + 'UNKNOWN' => 'UNKNOWN', + 'GREEN' => 'GREEN', + ], + 'example' => 'GREEN', + 'title' => '', + ], + 'CodeVerificationStatus' => [ + 'description' => 'The verification status of the phone number.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* REVOKED: The review application is revoked.'."\n" + .'* MORE_INFORMATION_REQUESTED: More information needs to be provided.'."\n" + .'* VERIFIED: The phone number passes the verification.'."\n" + .'* REJECTED: The phone number fails to pass the verification.'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'REVOKED' => '', + 'MORE_INFORMATION_REQUESTED' => '', + 'VERIFIED' => '', + 'REJECTED' => '', + ], + 'example' => 'VERIFIED', + 'title' => '', + ], + 'NewNameStatus' => [ + 'description' => 'The review status of the new display name of the enterprise.'."\n", + 'type' => 'string', + 'example' => 'Approval', + 'title' => '', + ], + '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' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '8613800000', + 'title' => '', + ], + 'StatusQueue' => [ + 'description' => 'The status report queue.'."\n", + 'type' => 'string', + 'example' => 'Alicom-Queue-****-ChatAppStatus', + 'title' => '', + ], + 'IsOfficial' => [ + 'description' => 'Indicates whether it is a WhatsApp Official Business Account (OBA).'."\n", + 'type' => 'string', + 'example' => 'N', + ], + 'UpCallbackUrl' => [ + 'description' => 'The URL that receives the MO messages.'."\n", + 'type' => 'string', + 'example' => 'https://ali.com/inbound', + 'title' => '', + ], + ], + ], + 'example' => '', + 'title' => '', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The message returned.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\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' => 'QueryChatappPhoneNumbers', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'QueryChatappBindWaba' => [ + 'summary' => 'Query the WhatsApp Business account you associate with ChatApp.', + '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' => 'The space ID of the user under the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + 'title' => '', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISV verification code, which is used to verify whether the user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'aksik93kdkkxmwol93939', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'SUCCESS', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AuthInternationalRateEligibility' => [ + 'description' => 'WABA related information.', + 'type' => 'object', + 'example' => '', + ], + 'MarketingMessageLiteStatus' => [ + 'description' => 'The Marketing Messaging Lite status.'."\n", + 'type' => 'string', + 'example' => 'Y', + ], + 'BusinessName' => [ + 'description' => 'The business name.'."\n", + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Currency' => [ + 'description' => 'The currency.'."\n", + 'type' => 'string', + 'example' => 'USD', + ], + 'Id' => [ + 'description' => 'The ID of the WhatsApp Business account.'."\n", + 'type' => 'string', + 'example' => '20393988393993***', + ], + 'AccountReviewStatus' => [ + 'description' => 'The review state of the WhatsApp Business account (WABA).'."\n" + ."\n" + .'> Valid values:'."\n" + ."\n" + .'* PENDING: The WABA is to be reviewed.'."\n" + ."\n" + .'* APPROVED: The WABA was approved.'."\n" + ."\n" + .'* REJECTED: The WABA was rejected.'."\n" + ."\n" + .'* DISABLED: The WABA was forbidden.'."\n", + 'type' => 'string', + 'example' => 'APPROVED', + ], + 'MessageTemplateNamespace' => [ + 'description' => 'The namespace of the message template.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'BusinessId' => [ + 'description' => 'The business ID.'."\n", + 'type' => 'string', + 'example' => '19293988***', + ], + 'Name' => [ + 'description' => 'The name of the WhatsApp Business account.'."\n", + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'PrimaryBusinessLocation' => [ + 'description' => 'The start time when the authentication-international rate applies.'."\n", + 'type' => 'string', + 'example' => '"start_time":1721952000', + ], + ], + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\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' => 'QueryChatappBindWaba', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'SendChatappMassMessage' => [ + 'summary' => 'Sends a message to multiple phone numbers by using ChatAPP at a time.', + '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' => [ + 'title' => '', + 'description' => 'The type of the channel. Valid values:'."\n" + ."\n" + .'* **whatsapp**'."\n" + .'* **viber**'."\n" + .'* **line** (under development)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'whatsapp', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The template code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '744c4b5c79c9432497a075bdfca36bf5', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The language. For more information about language codes, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The mobile phone number of the message sender.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861387777****', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'FallBackId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the fallback policy.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S00001', + ], + ], + [ + 'name' => 'FallBackContent', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The content of the fallback message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Fallback message'."\n", + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100000001', + ], + ], + [ + 'name' => 'SenderList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The mobile phone numbers of the message receivers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mobile phone numbers of the message receivers.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateParams' => [ + 'title' => '', + 'description' => 'The parameters of the template.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"param1":"value1","param2":"value2"}', + 'description' => 'The parameters of the template.'."\n", + ], + 'example' => '', + ], + 'FlowAction' => [ + 'title' => '', + 'description' => 'The Flow action.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowActionData' => [ + 'title' => '', + 'description' => 'The default parameter of the Flow.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"name":"name"}', + 'description' => 'The default parameter of the Flow.'."\n", + ], + 'example' => '', + ], + 'FlowToken' => [ + 'title' => '', + 'description' => 'The information about the Flow token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'kde****', + ], + ], + 'required' => false, + 'example' => '', + ], + 'Payload' => [ + 'title' => 'payload', + 'description' => 'The payload of the button.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The payload of the button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["payloadtext1","payloadtext2","payloadtext3"]', + ], + 'required' => false, + 'maxItems' => 3, + 'minItems' => 0, + 'example' => '', + ], + 'To' => [ + 'title' => '', + 'description' => 'The mobile phone number of the message receiver.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '861388988****', + ], + 'ProductAction' => [ + 'title' => '', + 'description' => 'The information about the product.'."\n", + 'type' => 'object', + 'properties' => [ + 'ThumbnailProductRetailerId' => [ + 'title' => '', + 'description' => 'The retailer ID of the product.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skkks999393', + 'default' => 'siiek3993', + ], + 'Sections' => [ + 'title' => '', + 'description' => 'The products. Up to 30 products and 10 categories can be added.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The category of the product.'."\n", + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '', + 'description' => 'The name of the category.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcd', + ], + 'ProductItems' => [ + 'title' => '', + 'description' => 'The products.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The information about the product.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProductRetailerId' => [ + 'title' => '', + 'description' => 'The retailer ID of the product.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ksi399d8', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + 'deprecated' => true, + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The timeout period for sending messages when the ChannelType parameter is set to viber. Valid values: 30 to 1209600. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The type of the Viber message. Valid values:'."\n" + ."\n" + .'* **promotion**'."\n" + .'* **transaction**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'promotion', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The tag information when the ChannelType parameter is set to viber.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag', + ], + ], + [ + 'name' => 'FallBackDuration', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies the period of time after which the fallback message is sent if the message receipt that indicates the message is delivered to clients is not received. If this parameter is left empty, the fallback message is sent only when the message fails to be sent or the message receipt that indicates the message is not delivered to clients is received. Unit: seconds. Valid values: 60 to 43200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '43200', + 'minimum' => '60', + 'example' => '120', + ], + ], + [ + 'name' => 'FallBackRule', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The fallback rule. Valid values:'."\n" + ."\n" + .'* **undelivered**: A fallback is triggered if the message is not delivered to clients. When the message is being sent, the template parameters are verified. If the parameters fail to pass the verification, the message fails to be sent. Whether the template and phone number are prohibited is not verified. By default, this value is used when FallBackRule is left empty.'."\n" + .'* **sentFailed**: A fallback is triggered even if the template parameters including variables fail to pass the verification. If the channelType, type, messageType, to, and from parameters fail to pass the verification, a fallback is not triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'undelivered', + 'default' => 'undelivered', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'GroupMessageId' => [ + 'title' => '', + 'description' => 'The ID of the message group.'."\n", + 'type' => 'string', + 'example' => '890000010002****', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + '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' => 'SendChatappMassMessage', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n" + ."\n" + .'You can send messages to up to 1,000 phone numbers in a single request.'."\n", + ], + 'SendChatappMessage' => [ + 'summary' => 'Sends messages by using 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' => [ + 'title' => '', + 'description' => 'The channel type. Valid values:'."\n" + ."\n" + .'* **whatsapp**'."\n" + .'* **viber**'."\n" + .'* **line** (under development)'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'whatsapp', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The message type. Valid values:'."\n" + ."\n" + .'* **template**: the template message. A template message is sent based on a template that is created and approved in the Chat App Message Service console. You can send template messages based on your business requirements.'."\n" + .'* **message**: the custom message. You can send a custom WhatsApp message to a user only within 24 hours after you receive the last message from the user. This limit does not apply to custom Viber messages.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'template', + ], + ], + [ + 'name' => 'MessageType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The specific type of the message. This parameter is required only if you set the Type parameter to **message**.'."\n" + ."\n" + .'**Valid values of MessageType when you set the ChannelType parameter to whatsapp:**'."\n" + ."\n" + .'* **text**: a text message.'."\n" + .'* **image**: an image message.'."\n" + .'* **video**: a video message.'."\n" + .'* **audio**: an audio message.'."\n" + .'* **document**: a document message.'."\n" + .'* **interactive**: an interactive message.'."\n" + .'* **contacts**: a contact message.'."\n" + .'* **location**: a location message.'."\n" + .'* **sticker**: a sticker message.'."\n" + .'* **reaction**: a reaction message.'."\n" + ."\n" + .'**Valid values of MessageType when you set the ChannelType parameter to viber:**'."\n" + ."\n" + .'* **text**: a text message.'."\n" + .'* **image**: an image message.'."\n" + .'* **video**: a video message.'."\n" + .'* **document**: a document message.'."\n" + .'* **text_button**: a message that contains the text and button media objects.'."\n" + .'* **text_image_button**: a message that contains multiple media objects, including the text, image, and button.'."\n" + .'* **text_video**: a message that contains the text and video media objects.'."\n" + .'* **text_video_button**: a message that contains multiple media objects, including text, video, and button.'."\n" + .'* **text_image**: a message that contains the text and image media objects.'."\n" + ."\n" + .'> For more information, see [Parameters of a message template](~~454530~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text ', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The code of the message template. This parameter is required only if you set the Type parameter to **template**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The language that is used in the message template. This parameter is required only if you set the Type parameter to **template**. For more information about language codes, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The mobile phone number of the message sender.'."\n" + ."\n" + .'> You can specify a mobile phone number that is registered for a WhatsApp account and is approved in the Chat App Message Service console.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1360000****', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The mobile phone number of the message receiver.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'TemplateParams', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The variables of the message template.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The values of the variables that are included in the message template. The values must be in the JSON format. If a variable exists in the template, this parameter is required.'."\n", + 'example' => '{"param1":"value1","param2":"value2"}', + ], + 'example' => '', + ], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The message content.'."\n" + ."\n" + .'**Notes on WhatsApp messages:**'."\n" + ."\n" + .'* If you set **messageType** to **text**, you must specify **text** and must not specify **Caption**.'."\n" + .'* If you set **messageType** to **image**, you must specify **Link**.'."\n" + .'* If you set **messageType** to **video**, you must specify **Link**.'."\n" + .'* If you set **messageType** to **audio**, **Link** is required and **Caption** is invalid.'."\n" + .'* If you set **messageType** to **document**, **Link** and **FileName** are required and **Caption** is invalid.'."\n" + .'* If you set **messageType** to **interactive**, you must specify **type** and **action**.'."\n" + .'* If you set **messageType** to **contacts**, you must specify **name**.'."\n" + .'* If you set **messageType** to **location**, you must specify **longitude** and **latitude**.'."\n" + .'* If you set **messageType** to **sticker**, you must specify **Link**, and **Caption** and **FileName** are invalid.'."\n" + .'* If you set **messageType** to **reaction**, you must specify **messageId** and **emoji**.'."\n" + ."\n" + .'**Notes on Viber messages:**'."\n" + ."\n" + .'* If you set **messageType** to **text**, you must specify **text**.'."\n" + .'* If you set **messageType** to **image**, you must specify **link**.'."\n" + .'* If you set **messageType** to **video**, you must specify **link**, **thumbnail**, **fileSize**, and **duration**.'."\n" + .'* If you set **messageType** to **document**, you must specify **link**, **fileName**, and **fileType**.'."\n" + .'* If you set **messageType** to **text_button**, you must specify **text**, **caption**, and **action**.'."\n" + .'* If you set **messageType** to **text_image_button**, you must specify **text**, **link**, **caption**, and **action**.'."\n" + .'* If you set **messageType** to **text_video**, you must specify **text**, **link**, **thumbnail**, **fileSize**, and **duration**.'."\n" + .'* If you set **messageType** to **text_video_button**, you must specify **text**, **link**, **thumbnail**, **fileSize**, **duration**, and **caption**. In addition, you must not specify **action**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"text\\": \\"hello whatsapp\\", \\"link\\": \\"\\", \\"caption\\": \\"\\", \\"fileName\\": \\"\\" }', + ], + ], + [ + 'name' => 'Payload', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The payload of the button.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The payload of the button in the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'payloadtext1,payloadtext2,payloadtext3', + ], + 'required' => false, + 'example' => 'payloadtext1,payloadtext2,payloadtext3', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'FallBackId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the fallback policy. You can create a fallback policy and view the information in the Chat App Message Service console.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S_000001', + ], + ], + [ + 'name' => 'FallBackContent', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The content of the fallback message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a fallback message.', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + 'deprecated' => true, + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + ], + ], + [ + 'name' => 'ContextMessageId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The ID of the reply message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '61851ccb2f1365b16aee****', + ], + ], + [ + 'name' => 'TrackingData', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The tracking data of the Viber message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tracking_id:123456', + ], + ], + [ + 'name' => 'Label', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The type of the Viber message. This parameter is required if ChannelType is set to viber. Valid values:'."\n" + ."\n" + .'* **promotion**'."\n" + .'* **transaction**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'promotion', + ], + ], + [ + 'name' => 'Ttl', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The timeout period for sending the Viber message. Valid values: 30 to 1209600. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '50', + 'default' => '120', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The tag information of the Viber message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'tag', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The task ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '100000001', + ], + ], + [ + 'name' => 'FallBackDuration', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'Specifies the period of time after which the fallback message is sent if the message receipt that indicates the message is delivered to clients is not received. If this parameter is left empty, the fallback message is sent only when the **message fails to be sent** or **the message receipt that indicates the message is not delivered to clients** is received. Unit: seconds. Valid values: 60 to 43200.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '43200', + 'minimum' => '60', + 'example' => '120', + ], + ], + [ + 'name' => 'ProductAction', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The information about the products included in the WhatsApp catalog message or multi-product message (MPM).'."\n", + 'type' => 'object', + 'properties' => [ + 'ThumbnailProductRetailerId' => [ + 'title' => '', + 'description' => 'The retailer ID of the product.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S238SK', + ], + 'Sections' => [ + 'title' => '', + 'description' => 'The products. Up to 30 products and 10 categories can be added.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The category of the product.'."\n", + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'title' => '', + 'description' => 'The name of the category.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Test'."\n", + ], + 'ProductItems' => [ + 'title' => '', + 'description' => 'The products.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The product information.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProductRetailerId' => [ + 'title' => '', + 'description' => 'The retailer ID of the product.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '9I39E9E', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'FallBackRule', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The fallback rule. Valid values:'."\n" + ."\n" + .'* **undelivered**: A fallback is triggered if the message is not delivered to clients. When the message is being sent, the template parameters are verified. If the parameters fail to pass the verification, the message fails to be sent. Whether the template and phone number are prohibited is not verified. By default, this value is used when FallBackRule is left empty.'."\n" + .'* **sentFailed**: A fallback is triggered even if the template parameters including variables fail to pass the verification. If the channelType, type, messageType, to, and from parameters fail to pass the verification, a fallback is not triggered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'undelivered', + 'default' => 'undelivered', + ], + ], + [ + 'name' => 'FlowAction', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The Flow action.'."\n", + 'type' => 'object', + 'properties' => [ + 'FlowActionData' => [ + 'title' => '', + 'description' => 'The default parameter of the Flow.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'example' => '{"name":"test"}', + 'description' => 'The default parameter of the Flow.'."\n", + ], + 'example' => '', + ], + 'FlowToken' => [ + 'title' => '', + 'description' => 'The Flow token.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1122***', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'RecipientType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => 'individual', + 'default' => 'individual', + ], + ], + [ + 'name' => 'MessageCampaignId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AdAccountId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TokenType', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'MessageId' => [ + 'title' => '', + 'description' => 'The ID of the message that was sent.'."\n", + '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' => 'SendChatappMessage', + 'description' => 'You can call this operation up to 200 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + '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' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'CallAction', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'BusinessNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'UserNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'Session', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SdpType' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + 'Sdp' => [ + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'type' => 'object', + 'properties' => [ + 'CallId' => [ + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'Code' => [ + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + '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"}]', + ], + 'CreateChatappTemplate' => [ + 'summary' => 'The HTTP status code.'."\n" + ."\n" + .'\\\\\\\\* Example: OK. This parameter indicates that the request is successful.'."\n" + .'\\\\\\\\* Other values indicate that the request fails. For more information, see \\\\\\\\[Error codes]\\\\\\(https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes).', + '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' => 'The category of the template if TemplateType is set to WHATSAPP. Valid values:'."\n" + ."\n" + .'* **UTILITY**: the transaction template'."\n" + .'* **MARKETING**: the marketing template'."\n" + .'* **AUTHENTICATION**: the authentication template'."\n" + ."\n" + .'The category of the template if TemplateType is set to VIBER. Valid values:'."\n" + ."\n" + .'* **text**: the template that contains only text'."\n" + .'* **image**: the template that contains only images'."\n" + .'* **text_image_button**: the template that contains text, images, and buttons'."\n" + .'* **text_button**: the template that contains text and buttons'."\n" + .'* **document**: the template that contains only documents'."\n" + .'* **video**: the template that contains only videos'."\n" + .'* **text_video**: the template that contains text and videos'."\n" + .'* **text_video_button**: the template that contains text, videos, and buttons'."\n" + .'* **text_image**: the template that contains text and images'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'The code of the message template.'."\n", + ], + ], + [ + 'name' => 'Components', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The components of the message template.'."\n" + ."\n" + .'> If Category is set to AUTHENTICATION, the Type sub-parameter of the Components parameter cannot be set to HEADER. If the Type sub-parameter is set to BODY or FOOTER, the Text sub-parameter of the Components parameter must be empty.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The component of the message template.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER、FOOTER 和 BUTTONS', + 'description' => 'The type of the component. Valid values:'."\n" + ."\n" + .'* **BODY**'."\n" + .'* **HEADER**'."\n" + .'* **FOOTER**'."\n" + .'* **BUTTONS**'."\n" + .'* **CAROUSEL**'."\n" + .'* **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* In a WhatsApp message template, a **Body** component cannot exceed 1,024 characters in length. A **HEADER** or **FOOTER** component cannot exceed 60 characters in length.'."\n" + ."\n" + .'* **FOOTER**, **CAROUSEL**, and **LIMITED_TIME_OFFER** components are not supported in Viber message templates.'."\n" + ."\n" + .'* In Viber message templates, media resources such as images, videos, and documents are placed in the **HEADER** component. If a Viber message contains text and an image, the image is placed below the text in the message received on a device.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The text of the message that you want to send.'."\n" + ."\n" + .'> If Category is set to AUTHENTICATION, the Text sub-parameter of the Components parameter must be empty.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello whatsapp', + ], + 'Format' => [ + 'title' => '格式'."\n" + .'TEXT-文本 IMGAGE-图片 DOCUMENT-文档 VIDEO-视频', + 'description' => 'The type of the media resource. Valid values:'."\n" + ."\n" + .'* **TEXT**'."\n" + .'* **IMAGE**'."\n" + .'* **DOCUMENT**'."\n" + .'* **VIDEO**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TEXT', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => 'The URL of the media resource.'."\n" + ."\n" + .'> We recommend that you use 800 × 800 images in Viber message templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://image.developer.aliyundoc.com', + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => 'The description of the document.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a video', + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => 'The name of the document.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'video name', + ], + 'Buttons' => [ + 'title' => '按钮', + 'description' => 'The buttons. Specify this parameter only if you set the Type sub-parameter of the Components parameter to **BUTTONS**.'."\n" + ."\n" + .'> ####'."\n" + ."\n" + .'* A marketing or utility WhatsApp message template can contain up to 10 buttons.'."\n" + ."\n" + .'* A WhatsApp message template can contain only one phone call button.'."\n" + ."\n" + .'* A WhatsApp message template can contain up to two URL buttons.'."\n" + ."\n" + .'* In a WhatsApp message template, a quick reply button cannot be used together with a phone call button or a URL button.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '素材路径', + 'description' => 'The button.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型'."\n" + .'PHONE_NUMBER（电话）,URL（网页按钮）和QUICK_REPLY（快速回复）', + 'description' => 'The type of the button. Valid values:'."\n" + ."\n" + .'* **PHONE_NUMBER**: phone call button'."\n" + .'* **URL**: URL button'."\n" + .'* **QUICK_REPLY**: quick reply button'."\n" + .'* **COPY_CODE**: copy code button'."\n" + .'* **ONE_TAP**: one-tap autofill button if Category is set to AUTHENTICATION'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Category is set to AUTHENTICATION for a WhatsApp message template, you can add only one button to the WhatsApp message template and you must set the Type sub-parameter of the Buttons parameter to COPY_CODE or ONE_TAP. If Type is set to COPY_CODE, the Text sub-parameter of the Buttons parameter is required. If Type is set to ONE_TAP, the Text, SignatureHash, PackageName, and AutofillText sub-parameters of the Buttons parameter are required. The value of Text is displayed if the desired app is not installed on the device. The value of Text indicates that you must manually copy the verification code.'."\n" + ."\n" + .'* You can add only one button to a Viber message template, and you must set the Type sub-parameter of the Buttons parameter to URL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The display name of the button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Call Me', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number. This parameter is valid only when the Type sub-parameter of the Buttons parameter is set to **PHONE_NUMBER**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '+861368897****', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => 'The URL to be accessed when you click the URL button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://example.com', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => 'The type of the URL. Valid values:'."\n" + ."\n" + .'* **static**'."\n" + .'* **dynamic**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => 'The app signing key hash that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'wi299382', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => 'The app package name that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'com.demo', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'The text of the one-tap autofill button. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'The unsubscribe button. This parameter is valid if Category is set to MARKETING and the Type sub-parameter of the Buttons parameter is set to QUICK_REPLY for a WhatsApp message template. Marketing messages will not be sent to customers if you configure message sending in the Chat App Message Service console and the customers click this button.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => 'The coupon code. It can contain only letters and digits. You can set this parameter to a variable such as $(couponCode). Specify the value of couponCode when you send a message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '120293', + ], + 'FlowId' => [ + 'title' => 'Flow id', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '479884093605183', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'The Flow action.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DATA_EXCHANGE'."\n" + .'* NAVIGATE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => 'The first screen in the Flow. This parameter is required if FlowAction is set to NAVIGATE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => 'List of supported apps.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => 'WhatsApp template is required when Category is Authoritative and Button Type is ONE_TAP/ZERO-TAP, indicating the signature hash value of the WhatsApp application.', + 'type' => 'string', + 'required' => false, + 'example' => 'ieid83kdiek', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => 'The name of the Android application package. This parameter is required if you create an Android application.', + 'type' => 'string', + 'required' => false, + 'example' => 'com.kuaidian.waimaistaff', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'The thumbnail URL of the video in the Viber message template.'."\n", + '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' => 'The length of the video in the Viber message template. Unit: seconds. Valid values: 0 to 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'The type of the document attached in the Viber message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'The validity period of the verification code in the WhatsApp authentication template. Unit: minutes. This parameter is valid only when Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to FOOTER. The validity period of the verification code is displayed in the footer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'The note indicating that customers cannot share verification codes with others. The note is displayed in the message body. This parameter is valid if Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to BODY for a WhatsApp message template.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'HasExpiration' => [ + 'title' => 'LTO模板中，是否有过期时间', + 'description' => 'Specifies whether the coupon code has an expiration time. Specify this parameter if the Type sub-parameter of the Components parameter is set to LIMITED_TIME_OFFER.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Cards' => [ + 'description' => 'The carousel cards of the carousel template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => 'Carousel模板卡片列表', + 'description' => 'The components of the carousel card.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER 和 BUTTONS', + 'description' => 'The type of the component. Valid values:'."\n" + ."\n" + .'* **BODY**'."\n" + .'* **HEADER**'."\n" + .'* **BUTTONS**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => 'The type of the media resource. This parameter is valid if the Type sub-parameter of the CardComponents parameter is set to HEADER. Valid values:'."\n" + ."\n" + .'* **IMAGE**'."\n" + .'* **VIDEO**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + 'Text' => [ + 'title' => 'Carousel轮播卡片中Body的内容', + 'description' => 'The body content of the carousel card.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Who is the very powerful team', + ], + 'Url' => [ + 'title' => 'Header，图片或视频的路径', + 'description' => 'The URL of the media resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/img.png', + ], + 'Buttons' => [ + 'title' => 'Carousel卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有2个按钮', + 'description' => 'The buttons. Specify this parameter only if you set the Type sub-parameter of the CardComponents parameter to BUTTONS. A carousel card can contain up to two buttons.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'title' => '按钮内容', + 'description' => 'The text of the button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Call me', + ], + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => 'The type of the button. Valid values:'."\n" + ."\n" + .'* **PHONE_NUMBER**: phone call button'."\n" + .'* **URL**: URL button'."\n" + .'* **QUICK_REPLY**: quick reply button'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => 'The URL to which you are redirected when you click the URL button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/xx', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => 'The type of the URL. Valid values:'."\n" + ."\n" + .'* **static**'."\n" + .'* **dynamic**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '+8613800', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称', + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'hello_whatsapp', + ], + ], + [ + 'name' => 'Language', + 'in' => 'formData', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'Example', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '变量，KEY-VALUE结构', + 'description' => 'The examples of variables that are used when you create the message template.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"textVariable":"text"}', + 'description' => 'The values of the variables. Before you specify this parameter, the format of the value must be changed from JSON to String.'."\n", + ], + 'enumValueTitles' => [], + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板类型', + 'description' => 'The type of the message template.'."\n" + ."\n" + .'* **WHATSAPP**'."\n" + .'* **VIBER**'."\n" + .'* LINE: the Line message template. This type of message template will be released later.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'The WhatsApp Business account (WABA) ID of the user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'The independent software vendor (ISV) verification code, which is used to verify whether the user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + 'docRequired' => true, + ], + ], + [ + 'name' => 'AllowCategoryChange', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否允许facebook自动变更模板的目录（这样能提高模板的审核通过率）此属性只对TemplateType=WHATSAPP有效', + 'description' => 'Specifies whether to allow Facebook to automatically change the directory of the template. If you set this parameter to true, the review success rate of the template is improved. This parameter is valid only when TemplateType is set to WHATSAPP.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'deprecated' => true, + ], + ], + [ + 'name' => 'MessageSendTtlSeconds', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Whatsapp中Authentication模板消息发送时的有效期', + 'description' => 'Validity period of authentication template message sending in WhatsApp'."\n" + ."\n" + .'> This attribute requires providing waba in advance to Alibaba operators to open the whitelist, otherwise it will result in template submission failure', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2592000', + 'minimum' => '30', + 'example' => '120', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '提示信息，当返回异常时有值', + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板Code', + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_232907****', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + ], + 'example' => '{"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}', + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + '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' => 'CreateChatappTemplate', + 'description' => '### [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ModifyChatappTemplate' => [ + 'summary' => 'The code of the message template.', + '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' => 'The components of the message template.'."\n" + ."\n" + .'> If Category is set to AUTHENTICATION, the Type sub-parameter of the Components parameter cannot be set to HEADER. If the Type sub-parameter is set to BODY or FOOTER, you do not need to set the Text sub-parameter of the Components parameter because the value is automatically generated.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The components of the message template.'."\n" + ."\n" + .'> If Category is set to AUTHENTICATION, the Type sub-parameter of the Components parameter cannot be set to HEADER. If the value of Type is BODY or FOOTER, the Text sub-parameter of the Components parameter is empty.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER、FOOTER 和 BUTTONS', + 'description' => 'The component type. Valid values:'."\n" + ."\n" + .'* **BODY**'."\n" + .'* **HEADER**'."\n" + .'* **FOOTER**'."\n" + .'* **BUTTONS**'."\n" + .'* **CAROUSEL**'."\n" + .'* **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* In a WhatsApp message template, a **Body** component cannot exceed 1,024 characters in length. A **HEADER** or **FOOTER** component cannot exceed 60 characters in length.'."\n" + ."\n" + .'* **FOOTER**, **CAROUSEL**, and **LIMITED_TIME_OFFER** components are not supported in Viber message templates.'."\n" + ."\n" + .'* In Viber message templates, media resources such as images, videos, and documents are placed in the **HEADER** component. If a Viber message contains text and an image, the image is placed below the text in the message received on a device.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The text of the message that you want to send.'."\n" + ."\n" + .'> If Category is set to AUTHENTICATION, do not specify the Text sub-parameter of the Components parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello chatapp', + ], + 'Format' => [ + 'title' => '格式'."\n" + .'TEXT-文本 IMGAGE-图片 DOCUMENT-文档 VIDEO-视频', + 'description' => 'The type of the media resource. Valid values:'."\n" + ."\n" + .'* **TEXT**'."\n" + .'* **IMAGE**'."\n" + .'* **DOCUMENT**'."\n" + .'* **VIDEO**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TEXT', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => 'The URL of the media resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://img.tukuppt.com/png_preview/00/10/24/1GygxVK3F4.jpg', + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => 'The description of the media resource.'."\n" + ."\n" + .'> If the Type sub-parameter of the Components parameter is set to **HEADER** and the Format parameter is set to **IMAGE, DOCUMENT, or VIDEO**, you can specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a video', + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => 'The name of the document.'."\n" + ."\n" + .'> If the Type sub-parameter of the Components parameter is set to **HEADER** and the Format parameter is set to **DOCUMENT**, you can specify this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'video name', + ], + 'Buttons' => [ + 'title' => '按钮', + 'description' => 'The buttons. Specify this parameter only if you set the Type sub-parameter of the Components parameter to **BUTTONS**.'."\n" + ."\n" + .'> ####'."\n" + ."\n" + .'* A marketing or utility WhatsApp message template can contain up to 10 buttons.'."\n" + ."\n" + .'* A WhatsApp message template can contain only one phone call button.'."\n" + ."\n" + .'* A WhatsApp message template can contain up to two URL buttons.'."\n" + ."\n" + .'* In a WhatsApp message template, a quick reply button cannot be used together with a phone call button or a URL button.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '素材路径', + 'description' => 'The button.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型'."\n" + .'PHONE_NUMBER（电话）,URL（网页按钮）和QUICK_REPLY（快速回复）', + 'description' => 'The button type. Valid values:'."\n" + ."\n" + .'* **PHONE_NUMBER**: phone call button'."\n" + .'* **URL**: URL button'."\n" + .'* **QUICK_REPLY**: quick reply button'."\n" + .'* **COPY_CODE**: copy code button'."\n" + .'* **ONE_TAP**: one-tap autofill button if Category is set to AUTHENTICATION'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Category is set to AUTHENTICATION for a WhatsApp message template, you can add only one button to the WhatsApp message template and you must set the Type sub-parameter of the Buttons parameter to COPY_CODE or ONE_TAP. If Type is set to COPY_CODE, the Text sub-parameter of the Buttons parameter is required. If Type is set to ONE_TAP, the Text, SignatureHash, PackageName, and AutofillText sub-parameters of the Buttons parameter are required. The value of Text is displayed if the desired app is not installed on the device. The value of Text indicates that you must manually copy the verification code.'."\n" + ."\n" + .'* You can add only one button to a Viber message template, and you must set the Type sub-parameter of the Buttons parameter to URL.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The text of the button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'phone-button-text', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '+8613888887889', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => 'The URL to which you are redirected when you click the URL button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.website.com/', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => 'The URL type. Valid values:'."\n" + ."\n" + .'* **static**'."\n" + .'* **dynamic**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dynamic', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => 'The app signing key hash that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '29dkeke', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => 'The app package name that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => 'com.demo', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'The text of the one-tap autofill button. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP for a WhatsApp message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'The unsubscribe button. This parameter is valid if Category is set to MARKETING and the Type sub-parameter of the Buttons parameter is set to QUICK_REPLY for a WhatsApp message template. Marketing messages will not be sent to customers if you configure message sending in the Chat App Message Service console and the customers click this button.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => 'The coupon code. It can contain only letters and digits. You can set this parameter to a variable such as $(couponCode). Specify the value of couponCode when you send a message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '120293', + ], + 'FlowId' => [ + 'title' => 'Flow id', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '664597077870605', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'The Flow action.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DATA_EXCHANGE'."\n" + .'* NAVIGATE'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => 'The first screen in the Flow. This parameter is required if FlowAction is set to NAVIGATE.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => 'List of supported apps.', + 'type' => 'array', + 'items' => [ + 'description' => 'List of supported apps.', + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => 'The Whatsapp template is required when the Category is\' Authorisation \'and the Button Type is\' ONE_TAP/ZERO-TAP\', indicating the signature hash value of the Whatsapp call application.', + 'type' => 'string', + 'required' => false, + 'example' => 'fk39kd93ks9', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => 'The Whatsapp template is required when the Category is\' Authorisation \'and the Button Type is\' ONE_TAP/ZERO-TAP\', indicating the signature hash value of the Whatsapp call application.', + 'type' => 'string', + 'required' => false, + 'example' => 'com.example.myapplication', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'The thumbnail URL of the video in the Viber message template.'."\n", + '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' => 'The length of the video in the Viber message template. Unit: seconds. Valid values: 0 to 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '120', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'The type of the document attached in the Viber message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'docx', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'The validity period of the verification code in the WhatsApp authentication template. Unit: minutes. This parameter is valid only when Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to FOOTER. The validity period of the verification code is displayed in the footer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'The note indicating that customers cannot share verification codes with others. The note is displayed in the message body. This parameter is valid if Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to BODY for a WhatsApp message template.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + 'HasExpiration' => [ + 'title' => 'LTO模板中，是否有过期时间', + 'description' => 'Specifies whether the coupon code has an expiration time. Specify this parameter if the Type sub-parameter of the Components parameter is set to LIMITED_TIME_OFFER.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Cards' => [ + 'description' => 'The carousel cards of the carousel template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => 'Carousel卡片中的控件列表', + 'description' => 'The components of the carousel card.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型'."\n" + .'值：BODY、HEADER 和 BUTTONS', + 'description' => 'The component type. Valid values:'."\n" + ."\n" + .'* **BODY**'."\n" + .'* **HEADER**'."\n" + .'* **BUTTONS**'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'BODY', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => 'The type of the media resource. This parameter is valid if the Type sub-parameter of the CardComponents parameter is set to HEADER. Valid values:'."\n" + ."\n" + .'* **IMAGE**'."\n" + .'* **VIDEO**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'IMAGE', + ], + 'Text' => [ + 'title' => 'Carousel轮播卡片中Body的内容', + 'description' => 'The body content of the carousel card.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Who is the very powerful team', + ], + 'Url' => [ + 'title' => 'Header，图片或视频的路径', + 'description' => 'The URL of the media resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/img.png'."\n", + ], + 'Buttons' => [ + 'title' => 'Carousel卡片中的按钮，所有卡片中的按钮类型、名称、顺序必须一致,每个卡片最多有2个按钮', + 'description' => 'The buttons. Specify this parameter only if you set the Type sub-parameter of the CardComponents parameter to BUTTONS. A carousel card can contain up to two buttons.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Text' => [ + 'title' => '按钮内容', + 'description' => 'The text of the button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Call me', + ], + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => 'The button type. Valid values:'."\n" + ."\n" + .'* **PHONE_NUMBER**: phone call button'."\n" + .'* **URL**: URL button'."\n" + .'* **QUICK_REPLY**: quick reply button'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'PHONE_NUMBER', + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => 'The URL to which you are redirected when you click the URL button.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com/xx'."\n", + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => 'The URL type. Valid values:'."\n" + ."\n" + .'* **static**'."\n" + .'* **dynamic**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '+8613800'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Language', + 'in' => 'formData', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'en', + ], + ], + [ + 'name' => 'Example', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '变量，KEY-VALUE结构', + 'description' => 'The examples of variables that are used when you create the message template.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"textVariable":"text"}'."\n", + 'description' => 'The examples of variables that are used when you create the message template.'."\n", + ], + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'The WhatsApp Business account (WABA) ID of the user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '659216218162179', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'The ISV verification code, which is used to verify whether the user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ksiekdki39ksks93939', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '消息模板编码', + 'description' => 'The message template code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '8472929283883', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + 'docRequired' => true, + ], + ], + [ + 'name' => 'Category', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Viber修改模板时，可以修改模板Category(Whatsapp修改时此参数无效）', + 'description' => 'The category of the Viber message template. Valid values:'."\n" + ."\n" + .'* **text**: the template that contains only text'."\n" + .'* **image**: the template that contains only images'."\n" + .'* **text_image_button**: the template that contains text, images, and buttons'."\n" + .'* **text_button**: the template that contains text and buttons'."\n" + .'* **document**: the template that contains only documents'."\n" + .'* **video**: the template that contains only videos'."\n" + .'* **text_video**: the template that contains text and videos'."\n" + .'* **text_video_button**: the template that contains text, videos, and buttons'."\n" + .'* **text_image**: the template that contains text and images'."\n" + ."\n" + .'> This parameter applies only to Viber message templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'text', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改模板的模板类型，取值为WHATSAPP/VIBER， 当未传递此值时，默认值为WHATSAPP', + 'description' => 'The type of the message template.'."\n" + ."\n" + .'* **WHATSAPP**'."\n" + .'* **VIBER**'."\n" + .'* LINE: the Line message template. This type of message template will be released later.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'MessageSendTtlSeconds', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Whatsapp中Authentication模板消息发送有效期', + 'description' => 'Validity period of authentication template message sending in WhatsApp'."\n" + ."\n" + .'>This attribute requires providing waba in advance to Alibaba operators to open the whitelist, otherwise it will result in template submission failure', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2592000', + 'minimum' => '30', + 'example' => '120', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'formData', + 'schema' => [ + 'title' => '模板名称', + 'description' => 'Template name.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '提示信息，当返回异常时有值', + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'NONE', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板Code', + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => '8472929283883', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => 'The name of the message template.', + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + ], + ], + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None'."\n", + ], + ], + ], + ], + [], + ], + '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' => 'ModifyChatappTemplate', + 'description' => 'The name of the message template.'."\n", + ], + 'ListChatappTemplate' => [ + 'summary' => 'Queries message templates.', + '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' => 'The name of the template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hello_whatsapp', + 'title' => '', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + 'title' => '', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'description' => 'The review state of the template. Valid values:'."\n" + ."\n" + .'* **pass**: The template is approved.'."\n" + .'* **fail**: The template is rejected.'."\n" + .'* **auditing**: The template is being reviewed.'."\n" + .'* **unaudit**: The review is suspended.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'pass', + 'title' => '', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The pagination settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '10', + 'title' => '', + ], + 'Index' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'title' => '', + ], + ], + 'required' => false, + 'example' => '"page": "{\\"index\\": 1,\\"size\\": 20}', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '28251486512358****', + 'title' => '', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the message template.'."\n" + ."\n" + .'* **WHATSAPP**'."\n" + .'* **VIBER**'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + 'title' => '', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '838888822*****', + 'title' => '', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => 'The category of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'AUTHENTICATION', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message returned.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'RequestId' => [ + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'ListTemplate' => [ + 'description' => 'The message templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The queried templates.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + 'title' => '', + ], + 'AuditStatus' => [ + 'description' => 'The review state of the template. Valid values:'."\n" + ."\n" + .'* **pass**: The template is approved.'."\n" + .'* **fail**: The template is rejected.'."\n" + .'* **auditing**: The template is being reviewed.'."\n" + .'* **unaudit**: The review is suspended.'."\n", + 'type' => 'string', + 'example' => 'pass', + 'title' => '', + ], + 'Category' => [ + 'description' => 'The category of the WhatsApp message template. Valid values:'."\n" + ."\n" + .'* **UTILITY**'."\n" + .'* **MARKETING**'."\n" + .'* **AUTHENTICATION**'."\n" + ."\n" + .'The category of the Viber template. Valid values:'."\n" + ."\n" + .'* **text**: template that contains only text'."\n" + .'* **image**: template that contains only images'."\n" + .'* **text_image_button**: template that contains text, images, and buttons'."\n" + .'* **text_button**: template that contains text and buttons'."\n" + .'* **document**: template that contains only documents'."\n" + .'* **video**: template that contains only videos'."\n" + .'* **text_video**: template that contains text and videos'."\n" + .'* **text_video_button**: template that contains text, videos, and buttons'."\n" + .'* **text_image**: template that contains text and images'."\n", + 'type' => 'string', + 'example' => 'TRANSACTIONAL', + 'title' => '', + ], + 'Language' => [ + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'example' => 'en', + 'title' => '', + ], + 'LastUpdateTime' => [ + 'description' => 'The time when the template was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1711006633000', + 'title' => '', + ], + 'TemplateName' => [ + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'example' => 'hello_whatsapp', + 'title' => '', + ], + 'TemplateType' => [ + 'description' => 'The type of the template. Valid values: WHATSAPP and VIBER.'."\n", + 'type' => 'string', + 'example' => 'WHATSAPP', + 'title' => '', + ], + 'Reason' => [ + 'description' => 'The reason why the template was rejected.'."\n", + 'type' => 'string', + 'example' => 'None', + 'title' => '', + ], + ], + ], + 'example' => '', + 'title' => '', + ], + 'Total' => [ + 'description' => 'The total number of returned entries.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => 'The HTTP status code returned.'."\n" + ."\n" + .'* A value of OK indicates that the call is successful.'."\n" + .'* Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**: The request was successful.'."\n" + .'* **false**: The request failed.'."\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' => 'ListChatappTemplate', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetChatappTemplateDetail' => [ + 'summary' => 'Queries the information of a message template.', + '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' => 'The code of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '****4b5c79c9432497a075bdfca36bf5', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '语言', + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'en_US', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ISV客户WabaId, 后续会被弃用，请使用CustSpaceId', + 'description' => 'The WhatsApp Business account (WABA) ID of the user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'deprecated' => true, + 'required' => false, + 'example' => '65921621816****'."\n", + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'Isv校验码，用于校验子帐号是否由ISV授权', + 'description' => 'The independent software vendor (ISV) verification code. This parameter is used to verify whether the user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ISV子客户的SpaceId', + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '模板的模板类型，取值为WHATSAPP/VIBER， 当未传递此值时，默认值为WHATSAPP', + 'description' => 'The type of the message template. Valid values:'."\n" + ."\n" + .'* **WHATSAPP**'."\n" + .'* **VIBER**'."\n" + .'* LINE (developing)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => 'Name of a template.', + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Code' => [ + 'title' => '返回结果 OK 为正常', + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* Example: OK. This value indicates that the request is successful.'."\n" + .'* Other codes indicate that the request fails. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + ], + 'Data' => [ + 'title' => 'TemplateDetail', + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Category' => [ + 'title' => '模板分类', + 'description' => 'The category of the template when the returned value of TemplateType is WHATSAPP. Valid values:'."\n" + ."\n" + .'* **UTILITY**: a transactional template'."\n" + .'* **MARKETING**: a marketing template'."\n" + .'* **AUTHENTICATION**: an identity authentication template'."\n" + ."\n" + .'The category of the template when the returned value of the TemplateType parameter is VIBER. Valid values:'."\n" + ."\n" + .'* **text**: a template that contains only text'."\n" + .'* **image**: a template that contains only images'."\n" + .'* **text_image_button**: a template that contains text, images, and buttons'."\n" + .'* **text_button**: a template that contains text and buttons'."\n" + .'* **document**: a template that contains only files'."\n" + .'* **video**: a template that contains only videos'."\n" + .'* **text_video**: a template that contains text and videos'."\n" + .'* **text_video_button**: a template that contains text, videos, and buttons'."\n" + .'* **text_image**: a template that contains text and images'."\n" + ."\n" + .'> If Category is set to text_video_button, users cannot open a web page by clicking the button. Users can open only the video in the message. In this case, you do not need to specify the Url parameter for the URL button in the template.'."\n", + 'type' => 'string', + 'example' => 'TRANSACTIONAL', + ], + 'TemplateCode' => [ + 'title' => '模板编码', + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => '744c4b5c79c9432497a075bdfca3****', + ], + 'Name' => [ + 'title' => '模板名称', + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'example' => 'hello_whatsapp', + ], + 'Language' => [ + 'title' => '语言', + 'description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).'."\n", + 'type' => 'string', + 'example' => 'en_US', + ], + 'Example' => [ + 'title' => '变量例子', + 'description' => 'The examples of variables.'."\n", + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'The values of the variables that are included in the message template. The values must be in the JSON format.'."\n", + 'example' => '{\\"textVariable\\":\\"text\\",\\"linkVariable\\":\\"https://image.developer.aliy\\"}', + ], + ], + 'AuditStatus' => [ + 'title' => '审核状态', + 'description' => 'The review status of the message template. Valid values:'."\n" + ."\n" + .'* **pass**: The message template is approved.'."\n" + .'* **fail**: The message template is rejected.'."\n" + .'* **auditing**: The message template is being reviewed.'."\n" + .'* **unaudit**: The review is suspended.'."\n", + 'type' => 'string', + 'example' => 'pass', + ], + 'Components' => [ + 'title' => '消息模板组件', + 'description' => 'The components of the message template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型', + 'description' => 'The component type. Valid values:'."\n" + ."\n" + .'* **BODY**'."\n" + .'* **HEADER**'."\n" + .'* **FOOTER**'."\n" + .'* **BUTTONS**'."\n" + .'* **CAROUSEL**'."\n" + .'* **LIMITED_TIME_OFFER**'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* In a WhatsApp message template, a **Body** component cannot exceed 1,024 characters in length. A **HEADER** or **FOOTER** component cannot exceed 60 characters in length.'."\n" + ."\n" + .'* **FOOTER**, **CAROUSEL**, and **LIMITED_TIME_OFFER** components are not supported in Viber message templates.'."\n" + ."\n" + .'* In Viber message templates, media resources such as images, videos, and documents are placed in the **HEADER** component. If a Viber message contains text and an image, the image is placed below the text in the message received on a device.'."\n", + 'type' => 'string', + 'example' => 'BODY', + ], + 'Url' => [ + 'title' => '素材路径', + 'description' => 'The URL of the media resource.'."\n", + 'type' => 'string', + 'example' => 'https://image.developer.aliyundoc.com', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The text of the message that you want to send.'."\n", + 'type' => 'string', + 'example' => 'Hello'."\n", + ], + 'Caption' => [ + 'title' => '描述，当Type为Header，且Format为IMGAGE/DOCUMENT/VIDEO 可以增加描述', + 'description' => 'The description of the document.'."\n", + 'type' => 'string', + 'example' => 'The new file has been uploaded.'."\n", + ], + 'FileName' => [ + 'title' => '文件名称，当Type为Header，且Format为DOCUMENT时可以给文件指定名称', + 'description' => 'The name of the document.'."\n", + 'type' => 'string', + 'example' => 'Express file'."\n", + ], + 'Format' => [ + 'title' => '格式', + 'description' => 'The format.'."\n", + 'type' => 'string', + 'example' => 'TEXT', + ], + 'Buttons' => [ + 'title' => '仅适用于 BUTTONS 类型。'."\n" + .'与按钮相关的参数。', + 'description' => 'The buttons. This parameter is returned only if the Type sub-parameter of the Components parameter is set to **BUTTONS**.'."\n" + ."\n" + .'> ####'."\n" + ."\n" + .'* A marketing or utility WhatsApp message template can contain up to 10 buttons.'."\n" + ."\n" + .'* A WhatsApp message template can contain only one phone call button.'."\n" + ."\n" + .'* A WhatsApp message template can contain up to two URL buttons.'."\n" + ."\n" + .'* In a WhatsApp message template, a quick reply button cannot be used together with a phone call button or a URL button.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '按钮类型', + 'description' => 'The button type. Valid values:'."\n" + ."\n" + .'* **PHONE_NUMBER**: phone call button'."\n" + .'* **URL**: URL button'."\n" + .'* **QUICK_REPLY**: quick reply button'."\n" + .'* **COPY_CODE**: copy code button'."\n" + .'* **ONE_TAP**: one-tap autofill button if Category is set to AUTHENTICATION'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If Category is set to AUTHENTICATION for a WhatsApp message template, you can add only one button to the WhatsApp message template and you must set the Type sub-parameter of the Buttons parameter to COPY_CODE or ONE_TAP. If Type is set to COPY_CODE, the Text sub-parameter of the Buttons parameter is required. If Type is set to ONE_TAP, the Text, SignatureHash, PackageName, and AutofillText sub-parameters of the Buttons parameter are required. The value of Text is displayed if the desired app is not installed on the device. The value of Text indicates that you must manually copy the verification code.'."\n" + ."\n" + .'* You can add only one button to a Viber message template, and you must set the Type sub-parameter of the Buttons parameter to URL.'."\n", + 'type' => 'string', + 'example' => 'PHONE_NUMBER', + ], + 'Text' => [ + 'title' => '所发送消息的文本', + 'description' => 'The display name of the button.'."\n", + 'type' => 'string', + 'example' => 'Call'."\n", + ], + 'PhoneNumber' => [ + 'title' => '电话号码', + 'description' => 'The phone number. This parameter is valid only if the Type sub-parameter of the Buttons parameter is set to **PHONE_NUMBER**.'."\n", + 'type' => 'string', + 'example' => '861398745****', + ], + 'Url' => [ + 'title' => '当按钮类型是'."\n" + .'URL 时有效', + 'description' => 'The URL to which you are redirected when you click the URL button.'."\n", + 'type' => 'string', + 'example' => 'https://example.com'."\n", + ], + 'UrlType' => [ + 'title' => 'WEB地址类型'."\n" + .'static-静态'."\n" + .'dynamic-动态', + 'description' => 'The URL type. Valid values:'."\n" + ."\n" + .'* **static**'."\n" + .'* **dynamic**'."\n", + 'type' => 'string', + 'example' => 'static', + ], + 'SignatureHash' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的签名Hash值', + 'description' => 'The app signing key hash that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP in a WhatsApp message template.'."\n", + 'type' => 'string', + 'example' => '2993839', + ], + 'PackageName' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，表示Whatsapp调起应用的包名', + 'description' => 'The app package name that WhatsApp uses to load your app. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP in a WhatsApp message template.'."\n", + 'type' => 'string', + 'example' => 'com.aliyun', + ], + 'AutofillText' => [ + 'title' => 'Whatsapp模板，Category为Authentication，并且Button Type为ONE_TAP时必填，Whatsap Autofill操作的按钮文本', + 'description' => 'The text of the one-tap autofill button. This parameter is required if Category is set to AUTHENTICATION and the Type sub-parameter of the Buttons parameter is set to ONE_TAP in a WhatsApp message template.'."\n", + 'type' => 'string', + 'example' => 'Autofill', + ], + 'IsOptOut' => [ + 'title' => 'Whatsapp模板，在Category为Marketing,并且Button type为QUICK_REPLY时有效，表示按钮为营销退订按钮，客户如果点击了此按钮，并且在chatapp平台上配置了发送控制操作，则后续Marketing消息则不会发送到客户', + 'description' => 'The unsubscribe button. This parameter is valid if Category is set to MARKETING and the Type sub-parameter of the Buttons parameter is set to QUICK_REPLY for a WhatsApp message template. Marketing messages will not be sent to customers if you configure message sending in the Chat App Message Service console and the customers click this button.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'ExtendAttrs' => [ + 'title' => '扩展字段', + 'description' => 'The extended fields.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextTemplateCode' => [ + 'title' => '下一个模板编码', + 'description' => 'The code of the next template.'."\n", + 'type' => 'string', + 'example' => '20939920093993', + ], + 'NextTemplateName' => [ + 'title' => '下一个模板名称', + 'description' => 'The name of the next template.'."\n", + 'type' => 'string', + 'example' => 'abc', + ], + 'NextLanguageCode' => [ + 'title' => '下一个模板语言', + 'description' => 'The language of the next template.'."\n", + 'type' => 'string', + 'example' => 'en', + ], + 'Action' => [ + 'title' => '事件类型', + 'description' => 'The event type.'."\n", + 'type' => 'string', + 'example' => 'nextCard', + ], + 'IntentCode' => [ + 'title' => '意图编码', + 'description' => 'The intent code.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + 'CouponCode' => [ + 'title' => '优惠券码', + 'description' => 'The coupon code.'."\n", + 'type' => 'string', + 'example' => '202039ksjs', + ], + 'FlowId' => [ + 'title' => 'Flow ID', + 'description' => 'The Flow ID.'."\n", + 'type' => 'string', + 'example' => '3838292983', + ], + 'FlowAction' => [ + 'title' => 'flow 数据事件类型'."\n" + .'取值范围：NAVIGATE/DATA_EXCHANGE', + 'description' => 'The Flow action. Valid values: NAVIGATE and DATA_EXCHANGE.'."\n", + 'type' => 'string', + 'example' => 'NAVIGATE', + ], + 'NavigateScreen' => [ + 'title' => '跳转屏 '."\n" + .'在FlowAction=NAVIGATE时必填', + 'description' => 'The first screen in the Flow. This parameter is returned if FlowAction is set to NAVIGATE.'."\n", + 'type' => 'string', + 'example' => 'DETAILS', + ], + 'SupportedApps' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => 'The apps that support one-tap authentication and zero-tap authentication.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '验证码ONE_TAP/ZERO_TAP支持的应用', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SignatureHash' => [ + 'title' => '包签名hash', + 'description' => 'The app signing key hash.'."\n", + 'type' => 'string', + 'example' => '29kdkeik939', + ], + 'PackageName' => [ + 'title' => '包名', + 'description' => 'The app package name.'."\n", + 'type' => 'string', + 'example' => 'com.test', + ], + ], + ], + ], + ], + ], + ], + 'ThumbUrl' => [ + 'title' => 'Viber带视频消息的缩略图', + 'description' => 'The thumbnail URL of the video in the Viber message template.'."\n", + 'type' => 'string', + 'example' => 'https://img.png', + ], + 'Duration' => [ + 'title' => 'Viber视频消息的视频时长，取值范围 0 - 600', + 'description' => 'The length of the video in the Viber message template. Unit: seconds. Valid values: 0 to 600.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '50', + ], + 'FileType' => [ + 'title' => 'Viber文件消息的文件类型', + 'description' => 'The type of the document attached in the Viber message template.'."\n", + 'type' => 'string', + 'example' => 'docx', + ], + 'Latitude' => [ + 'title' => '位置纬度属性', + 'description' => 'The latitude of the location.'."\n", + 'type' => 'string', + 'example' => '28.001', + ], + 'Longitude' => [ + 'title' => '位置经度属性', + 'description' => 'The longitude of the location.'."\n", + 'type' => 'string', + 'example' => '120.002', + ], + 'LocationName' => [ + 'title' => '位置名称', + 'description' => 'The name of the location.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou'."\n", + ], + 'LocationAddress' => [ + 'title' => '位置地址', + 'description' => 'The address of the location.'."\n", + 'type' => 'string', + 'example' => 'Hangzhou'."\n", + ], + 'AddSecretRecommendation' => [ + 'title' => 'Whatsapp类型模板，Category为Authentication，并且Component Type为Body时有效，表示在Body上面显示不要将验证码信息提供给其它人的提示信息', + 'description' => 'The note indicating that customers cannot share verification codes with others. The note is displayed in the message body. This parameter is valid if Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to BODY for a WhatsApp message template.'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + 'CodeExpirationMinutes' => [ + 'title' => 'Whatsapp Authentication模板验证码有效期（分钟），只在Whatsapp类型消息，Category为Authentication并且Component Type为Footer时有效（此信息显示在Footer位置）', + 'description' => 'The validity period of the verification code in the WhatsApp authentication template. Unit: minutes. This parameter is valid only when Category is set to AUTHENTICATION and the Type sub-parameter of the Components parameter is set to FOOTER for a WhatsApp message template. The validity period of the verification code is displayed in the footer.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '90', + 'minimum' => '1', + 'example' => '5', + ], + 'hasExpiration' => [ + 'title' => 'LTO模板中，优惠码是否有过期时间', + 'description' => 'Indicates whether the coupon code has an expiration time in the limited-time offer template.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'OfferExpirationTimeMs' => [ + 'title' => 'LTO模板时，优惠码过期变量', + 'description' => 'The variable when the coupon code expires in the limited-time offer template.'."\n", + 'type' => 'string', + 'example' => '$(offerExpirationTimeMs)', + ], + 'Cards' => [ + 'title' => '轮播卡片列表', + 'description' => 'The carousel cards.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CardComponents' => [ + 'title' => '卡片控件列表', + 'description' => 'The components of the carousel card.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '组件类型', + 'description' => 'The component type.'."\n", + 'type' => 'string', + 'example' => 'HEADER', + ], + 'Text' => [ + 'title' => '卡片文本内容', + 'description' => 'The text of the carousel card.'."\n", + 'type' => 'string', + 'example' => 'Body', + ], + 'Url' => [ + 'title' => '网页地址', + 'description' => 'The URL.'."\n", + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'Format' => [ + 'title' => 'Carousel模板中Header的类型，只支持IMAGE/VIDEO，所有卡片的Header必须一致'."\n" + .'格式'."\n" + .' IMGAGE-图片 VIDEO-视频', + 'description' => 'The type of the header in the carousel template. The header can only be an image or a video. The headers of all carousel cards must be the same. The type of the media resources that are included in the message. Valid values: IMGAGE and VIDEO.'."\n", + 'type' => 'string', + 'example' => 'HEADER', + ], + 'Buttons' => [ + 'title' => '卡片按钮列表', + 'description' => 'The buttons of the carousel card.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => 'Carousel模板的按钮类型'."\n" + .'取值：URL/PHONE_NUMBER/QUICK_REQLY', + 'description' => 'The type of the button in the carousel template. Valid values: URL, PHONE_NUMBER, and QUICK_REQLY.'."\n", + 'type' => 'string', + 'example' => 'URL', + ], + 'Text' => [ + 'title' => '按钮内容', + 'description' => 'The button text.'."\n", + 'type' => 'string', + 'example' => 'Button text'."\n", + ], + 'Url' => [ + 'title' => '点击按钮后将访问的网址', + 'description' => 'The URL to which you are redirected when you click the URL button.'."\n", + 'type' => 'string', + 'example' => 'https://aliyun.com', + ], + 'UrlType' => [ + 'title' => '网址类型 static-静态dynamic-动态', + 'description' => 'The type of the URL. Valid values: static and dynamic.'."\n", + 'type' => 'string', + 'example' => 'static', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '+86138000', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + ], + ], + 'TemplateType' => [ + 'title' => '模板类型，取值为WHATSAPP/VIBER', + 'description' => 'The type of the message template. Valid values:'."\n" + ."\n" + .'* **WHATSAPP**'."\n" + .'* **VIBER**'."\n" + .'* LINE (developing)'."\n", + 'type' => 'string', + 'example' => 'WHATSAPP', + ], + 'QualityScore' => [ + 'title' => '模板质量', + 'description' => 'The quality of the template.'."\n", + 'type' => 'string', + 'example' => 'GREEN', + ], + 'MessageSendTtlSeconds' => [ + 'title' => 'Whatsapp中Authentication类型模板发送消息时的消息有效期', + 'description' => 'The validity period of the WhatsApp authentication message.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'maximum' => '600', + 'minimum' => '60', + 'example' => '120', + ], + 'Reason' => [ + 'title' => '模板审核审核被拒的原因', + 'description' => 'The reason why the template was rejected.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'CategoryChangePaused' => [ + 'title' => 'Utility类型模板变更为Marketing类型时，模板暂停发送', + 'type' => 'boolean', + ], + 'AllowSend' => [ + 'title' => '当前模板是否能发送（仅对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' => 'Access denied details.', + '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\\": \\"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' => 'GetChatappTemplateDetail', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this API operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'DeleteChatappTemplate' => [ + 'summary' => 'Deletes a message template.', + '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' => 'The template code.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '744c4b5c79c9432497a075bdfca3****', + 'title' => '', + ], + ], + [ + 'name' => 'CustWabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The WhatsApp Business Account (WABA) ID of the RAM user within the independent software vendor (ISV) account.'."\n" + ."\n" + .'> CustWabaId is an obsolete parameter. Use CustSpaceId instead.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '65921621816****', + 'title' => '', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ISV verification code. This parameter is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + 'title' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28251486512358****', + 'title' => '', + 'docRequired' => true, + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_name', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template language.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The template type. This parameter is required if you delete a template in a language.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WHATSAPP', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'User not authorized to operate on the specified resource.', + 'title' => '', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + 'title' => '', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'DeleteChatappTemplate', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to five times per second per account. If the number of the calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ListProductCatalog' => [ + 'summary' => 'Queries the product catalogs on the Business Manager platform of Meta.', + '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' => 'The Business Manager ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '28', + ], + ], + [ + 'name' => 'Before', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cursor that points to the beginning of the page of the returned data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wiidkd939kek93', + ], + ], + [ + 'name' => 'After', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cursor that points to the end of the page of the returned data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'kdkii48jfjjei3', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fields. Separate multiple fields with commas (,).'."\n" + .'see [catalog fields](~~2579419~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'id,name', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of catalogs to be queried. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '73', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => ' '."\n" + .'90E63D28-E31D-1EB2-8939-A9486641****'."\n", + ], + 'Model' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Paging' => [ + 'description' => 'The pagination details.'."\n", + 'type' => 'object', + 'properties' => [ + 'Cursors' => [ + 'description' => 'The cursors for pagination.'."\n", + 'type' => 'object', + 'properties' => [ + 'Before' => [ + 'description' => 'The cursor that points to the beginning of the page of the returned data.'."\n", + 'type' => 'string', + 'example' => 'sjjsjdjjdjd83883', + ], + 'After' => [ + 'description' => 'The cursor that points to the end of the page of the returned data.'."\n", + 'type' => 'string', + 'example' => 'sjsuueu83838', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'example' => '{"id":"2999293993", "name":"catalog_name"}', + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ListProductCatalog', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetWhatsappConnectionCatalog' => [ + 'summary' => 'Queries the product catalogs that are associated with a WhatsApp Business account (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' => 'The WABA ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '292939399393', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'C2020939922929292', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'Model' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'example' => '{"id":"200292992"}', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'GetWhatsappConnectionCatalog', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'ListProduct' => [ + 'summary' => 'Queries products in a product catalog.', + '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' => 'The catalog ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '29398389292', + ], + ], + [ + 'name' => 'Fields', + 'in' => 'query', + 'schema' => [ + 'description' => 'The fields. Separate multiple fields with commas (,).'."\n" + ."\n" + .' see [product fields](~~2579419~~)', + 'type' => 'string', + 'required' => false, + 'example' => 'id,name', + ], + ], + [ + 'name' => 'Before', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cursor that points to the beginning of the page of the returned data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'wiidkd939kek93', + ], + ], + [ + 'name' => 'After', + 'in' => 'query', + 'schema' => [ + 'description' => 'The cursor that points to the end of the page of the returned data.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'kdkii48jfjjei3', + ], + ], + [ + 'name' => 'Limit', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of products to be queried. Valid values: 1 to 1000.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '73', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The space ID of the user within the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'C29398388383', + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the WhatsApp Business account (WABA).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '38487474747', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", + ], + 'Model' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Paging' => [ + 'description' => 'The pagination details.'."\n", + 'type' => 'object', + 'properties' => [ + 'Cursors' => [ + 'description' => 'The cursors for pagination.'."\n", + 'type' => 'object', + 'properties' => [ + 'Before' => [ + 'description' => 'The cursor that points to the beginning of the page of the returned data.'."\n", + 'type' => 'string', + 'example' => 'sjjsjdjjdjd83883', + ], + 'After' => [ + 'description' => 'The cursor that points to the end of the page of the returned data.'."\n", + 'type' => 'string', + 'example' => 'sjsuueu83838', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The product data.'."\n", + 'type' => 'object', + 'example' => '{"id":"293983883", "name":"product1"}', + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'ListProduct', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetChatappPhoneNumberMetric' => [ + 'summary' => 'Queries the number of messages that are sent by using a phone number by a specific metric.', + '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' => [ + 'title' => '', + 'description' => 'The independent software vendor (ISV) verification code, which is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The granularity of the metric.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DAILY'."\n" + .'* HALF_HOUR'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DAILY' => 'DAILY', + 'HALF_HOUR' => 'HALF_HOUR', + ], + 'example' => 'DAILY', + 'default' => 'DAILY', + ], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693107714687', + ], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693407714687', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The business phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '861380000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'NONE', + ], + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '1612C226-E271-4CFE-9F18-4066D******', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'DeliveredCount' => [ + 'description' => 'The number of delivered messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Start' => [ + 'description' => 'The beginning of the time range that you queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1669619491000', + ], + 'PhoneNumber' => [ + 'description' => 'The business phone number.'."\n", + 'type' => 'string', + 'example' => '861380000', + ], + 'End' => [ + 'description' => 'The end of the time range that you queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1667196043904', + ], + 'Granularity' => [ + 'description' => 'The granularity of the metric.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DAILY'."\n" + .'* HALF_HOUR'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'DAILY' => 'DAILY', + 'HALF_HOUR' => 'HALF_HOUR', + ], + 'example' => 'DAILY', + ], + 'SentCount' => [ + 'description' => 'The number of sent messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The value OK indicates that the request was successful.'."\n", + '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' => 'GetChatappPhoneNumberMetric', + 'description' => 'You can call this operation up to 50 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'EnableWhatsappROIMetric' => [ + 'summary' => 'Enables the statistics on the metrics that are related to 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' => [ + 'title' => '', + 'description' => 'The verification code used to verify whether the RAM user is authorized by the independent software vendor (ISV) account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => 'NONE', + ], + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The value OK indicates that the request was successful.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'EnableWhatsappROIMetric', + 'description' => 'You can call this operation up to five times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetChatappTemplateMetric' => [ + 'summary' => 'Queries the metrics about a marketing template.', + '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' => [ + 'title' => '', + 'description' => 'The template code.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '744c4b5c79c9432497a075bdfca36bf5', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The template language.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'IsvCode', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The independent software vendor (ISV) verification code, which is used to verify whether the RAM user is authorized by the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'skdi3kksloslikdkkdk', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The space ID of the RAM user within the ISV account.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '293483938849493', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The template type. If you do not specify this parameter, the default value WHATSAPP is used.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* VIBER'."\n" + .'* WHATSAPP'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VIBER' => 'VIBER', + 'WHATSAPP' => 'WHATSAPP', + ], + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'Granularity', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The granularity of the metric.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* DAILY'."\n" + .'* HALF_HOUR'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DAILY' => 'DAILY', + 'HALF_HOUR' => 'HALF_HOUR', + ], + 'example' => 'DAILY', + 'default' => 'DAILY', + ], + ], + [ + 'name' => 'Start', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693107714687', + ], + ], + [ + 'name' => 'End', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1693407714687', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'The details about the access denial.'."\n", + 'type' => 'string', + 'example' => ' None', + ], + 'RequestId' => [ + 'title' => '', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '', + 'description' => 'The template code.'."\n", + 'type' => 'string', + 'example' => '83837774838*****', + ], + 'DeliveredCount' => [ + 'description' => 'The number of delivered messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'Language' => [ + 'title' => '', + 'description' => 'The template language.'."\n", + 'type' => 'string', + 'example' => 'en', + ], + 'Cliented' => [ + 'description' => 'The statistics on button clicks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The statistics on button clicks.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The button type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* phone_number_button'."\n" + .'* url_button'."\n" + .'* quick_relpy_button'."\n", + 'type' => 'string', + 'enumValueTitles' => [ + 'phone_number_button' => 'phone_number_button', + 'url_button' => 'url_button', + 'quick_relpy_button' => 'quick_relpy_button', + ], + 'example' => 'quick_reply_button', + ], + 'ButtonContent' => [ + 'description' => 'The text on the button.'."\n", + 'type' => 'string', + 'example' => 'Open url', + ], + 'Count' => [ + 'description' => 'The number of clicks.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + ], + ], + 'example' => '', + ], + 'Start' => [ + 'description' => 'The beginning of the time range you queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1673919240001', + ], + 'End' => [ + 'description' => 'The end of the time range you queried.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1668138331485', + ], + 'SentCount' => [ + 'description' => 'The number of sent messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'ReadCount' => [ + 'description' => 'The number of read messages.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => 'The value OK indicates that the request was successful.'."\n", + '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' => 'GetChatappTemplateMetric', + 'description' => 'You can call this operation up to 50 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'GetPreValidatePhoneId' => [ + 'summary' => 'Obtains the ID of a pre-registered phone number used for embedded signup without the need to re-obtain a verification code.', + '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' => 'The phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '861380000', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '预校验号码购买时提供的验证码', + 'description' => 'The verification code provided when you purchased the pre-registered phone number.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '208393', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'title' => '结果返回OK为正常', + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [Error codes](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'title' => '错误描述信息', + 'description' => 'The error message.'."\n", + 'type' => 'string', + 'example' => 'None', + ], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PhoneNumberId' => [ + 'title' => '号码ID', + 'description' => 'The ID of the phone number.'."\n", + 'type' => 'string', + 'example' => '8613800000000', + ], + 'PhoneNumber' => [ + 'title' => '号码', + 'description' => 'The phone number.'."\n", + 'type' => 'string', + 'example' => '929833', + ], + ], + ], + ], + ], + ], + ], + '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' => 'GetPreValidatePhoneId', + 'description' => 'You can call this operation up to 10 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.'."\n", + ], + 'CreateChatFlow' => [ + 'summary' => 'Create Chatflow', + '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' => 'Flow title', + 'type' => 'string', + 'required' => false, + 'example' => 'Auto Reply', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow remarks', + 'type' => 'string', + 'required' => false, + 'example' => 'ChatFlow for WhatsApp Customer Service Auto-Reply.', + ], + ], + [ + 'name' => 'FlowTriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow trigger type', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TriggeredManually' => 'TriggeredManually', + 'TriggeredByWhatsApp' => 'TriggeredByWhatsApp', + 'TriggeredByMessenger' => 'TriggeredByMessenger', + 'TriggeredByInstagram' => 'TriggeredByInstagram', + 'TriggeredByViber' => 'TriggeredByViber', + ], + 'example' => 'TriggeredByWhatsApp', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Response data', + 'type' => 'object', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Unique request ID.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => 'Returned data object.', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => 'Error code', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => 'Whether the call was successful.'."\n", + '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' => 'Create Chatflow', + 'translator' => 'machine', + ], + 'CreateChatFlowByImport' => [ + 'summary' => 'Import and create flow', + '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' => 'Flow title', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow remarks', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'FlowViewModel', + 'in' => 'query', + 'schema' => [ + 'description' => 'Imported flow DSL data', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => '示例值示例值', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => 'Returned data object.', + 'type' => 'object', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Request status code.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Whether the request was successful', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Import and Create ChatFlow', + 'translator' => 'machine', + ], + 'CreateChatFlowLogSetting' => [ + 'summary' => 'Create chatFlow log setting', + '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' => 'Process code.', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'."\n", + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true for success, false for failure.', + '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' => 'Create Process Log Setting', + 'translator' => 'machine', + ], + 'CreateFlowVersion' => [ + 'summary' => 'CreateFlowVersion', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersionCopyFrom', + 'in' => 'query', + 'schema' => [ + 'description' => 'The flow version to be copied.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Version remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'Fix Send WhatsApp Message Error', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial; this field is only returned when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Request status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true for success, false for failure.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Create Flow Version', + 'translator' => 'machine', + ], + 'DeleteChatFlow' => [ + 'summary' => 'Delete Process', + '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' => 'Process code.', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Response data', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Unique request ID.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => 'Error code', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => 'Whether the call was successful.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Delete Process', + 'translator' => 'machine', + ], + 'DeleteFlowVersion' => [ + 'summary' => 'Delete Flow Version', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Detailed reason for access denial.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Delete Flow Version', + 'translator' => 'machine', + ], + 'FlowBindPhone' => [ + 'summary' => 'Bind phone numbers to flow', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'ChannelCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message channel Code', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message channel Type', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Phone numbers or PageIds under the channel instance, etc.', + 'type' => 'array', + 'items' => [ + 'description' => 'Individual phone number or PageId, etc.', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA account ID, or PageId for other channel types, etc.', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial; this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error description message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Model' => [ + 'description' => 'Return result.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Bind Phone Numbers or Instances to Flow', + 'translator' => 'machine', + ], + 'FlowRebindPhone' => [ + 'summary' => 'Rebind phone number for flow', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'ChannelCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message channel code', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message channel type', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Phone numbers or PageIds under the channel instance, etc.', + 'type' => 'array', + 'items' => [ + 'description' => 'Single phone number or PageId, etc.', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'WabaId', + 'in' => 'query', + 'schema' => [ + 'description' => 'WABA account ID, or PageId for other channel types, etc.', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'description' => 'Request result data.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Rebind Phone Number or Instance for Flow', + 'translator' => 'machine', + ], + 'FlowUnbindPhone' => [ + 'summary' => 'Unbind phone number from flow', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Phone numbers or PageIds under the channel instance, etc.', + 'type' => 'array', + 'items' => [ + 'description' => 'Individual phone number or PageId, etc.', + 'type' => 'string', + 'required' => false, + 'example' => '86188********', + ], + 'required' => false, + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Message channel type', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Model' => [ + 'description' => 'Request result data.', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Code' => [ + 'description' => 'Request status code.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Unbind Phone Number or Instance from Flow', + 'translator' => 'machine', + ], + 'GetChatFlowTemplate' => [ + 'summary' => 'Query chatFlow template', + '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' => 'Template ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Unique request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + ], + ], + 'Code' => [ + 'description' => 'System returned error code. For more details on error codes, please refer to the error code documentation.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Query ChatFlow Template Details', + 'translator' => 'machine', + ], + 'ListBindingRelationsForFlowVersion' => [ + 'summary' => 'Query Bound List Based on flowCode', + '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' => 'Process code. View the process code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) interface.', + 'type' => 'string', + 'required' => true, + 'example' => '9ccc41**************************', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Channel type. Values:'."\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' => 'Access denied details.', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', + ], + 'Data' => [ + 'description' => 'Returned data list.', + 'type' => 'array', + 'items' => [ + 'description' => 'Returned data.'."\n", + 'type' => 'object', + ], + 'example' => '', + ], + 'Code' => [ + 'description' => 'Error code. For more information, see [Error Codes](~~196974~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values:'."\n" + ."\n" + .'- true: Success.'."\n" + ."\n" + .'- false: Failure.', + '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' => 'Query List of Bound Phone Numbers or Merchant Account IDs', + 'description' => '- You can call this interface to query the list of phone numbers or merchant account IDs bound to a process, or you can view the list in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **Settings** interface.'."\n" + ."\n" + .'- Before calling this interface, make sure that the process you created has already been bound to a phone number or merchant account ID.'."\n" + ."\n" + .'- If the process you created is not bound to a phone number or merchant account ID, you can manually bind a phone number or merchant account ID in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **Settings** interface, or bind it through the [FlowBindPhone](~~2937190~~) interface.', + 'translator' => 'machine', + ], + 'ListChatFlow' => [ + 'summary' => 'List Flows', + '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' => 'Flow status', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'NORMAL' => 'NORMAL', + ], + 'example' => 'NORMAL', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'FlowTriggerType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow trigger type, enum values:'."\n" + .'- TriggeredManually'."\n" + .'- TriggeredByWhatsApp'."\n" + .'- TriggeredByInstagram'."\n" + .'- TriggeredByViber'."\n" + .'- TriggeredByMessenger', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TriggeredManually' => 'TriggeredManually', + 'TriggeredByWhatsApp' => 'TriggeredByWhatsApp', + 'TriggeredByMessenger' => 'TriggeredByMessenger', + 'TriggeredByInstagram' => 'TriggeredByInstagram', + 'TriggeredByViber' => 'TriggeredByViber', + ], + 'example' => '示例值', + ], + ], + [ + 'name' => 'ReturnWithOnlineVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether to return the online status', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'false', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search keyword.', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Response data', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => 'System error code. For more details on error codes, please refer to the error code documentation.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Whether the request was successful.', + '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' => 'List Flows', + 'translator' => 'machine', + ], + 'ListChatFlowTemplate' => [ + 'summary' => 'ChatFlow Template List', + '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' => 'Trigger type, with the following enum values:'."\n" + ."\n" + .'- TriggeredManually'."\n" + .'- TriggeredByWhatsApp'."\n" + .'- TriggeredByInstagram'."\n" + .'- TriggeredByViber'."\n" + .'- TriggeredByMessenger', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TriggeredManually' => 'TriggeredManually', + 'TriggeredByWhatsApp' => 'TriggeredByWhatsApp', + 'TriggeredByMessenger' => 'TriggeredByMessenger', + 'TriggeredByInstagram' => 'TriggeredByInstagram', + 'TriggeredByViber' => 'TriggeredByViber', + ], + 'example' => 'TriggeredByWhatsApp', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => 'Search keyword.', + 'type' => 'string', + 'required' => false, + 'example' => 'LLM', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page number', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Number of records per page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'Returned data object.', + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + ], + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + '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' => 'List Flow Templates', + 'translator' => 'machine', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DOWN' => 'DOWN', + 'UP' => 'UP', + ], + 'example' => 'UP', + ], + ], + [ + 'name' => 'UserNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '86138***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'ClientAcceptStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '9938***', + ], + ], + [ + 'name' => 'GroupMessageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '9292****', + ], + ], + [ + 'name' => 'MessageStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Size' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '78', + ], + 'Index' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '49', + ], + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ConversationId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'BusinessNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'ClientAcceptStatusName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'MessageTypeName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'FailReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'EventActionName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Month' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'LanguageCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'TemplateName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'MessageType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'SendTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'MessageStatusName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'ClientReadStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'MessageSource' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'FailBackFlag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'UserNumber' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'TemplateCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'MessageStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Type' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'FailBackContent' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'EventAction' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'ClientReadStatusName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'UniqueMessageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'ChannelType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'MessageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ListFlowNodePrototypeV2' => [ + 'summary' => 'ListFlowNodePrototypeV2', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Core', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'Keyword', + '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' => [ + 'type' => 'string', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Model' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'GroupCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'PublicExtend' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '91', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'ListFlowVersion' => [ + 'summary' => 'List Flow Versions', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'Current page number.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'Page size.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version status.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DRAFT' => 'DRAFT', + 'DELETED' => 'DELETED', + 'ONLINE' => 'ONLINE', + 'OFFLINE' => 'OFFLINE', + ], + 'example' => 'DRAFT', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denied.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Whether the operation was successful. Values: true: success; false: failure.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'List Flow Versions', + 'translator' => 'machine', + ], + 'OfflineFlowVersion' => [ + 'summary' => 'Offline Flow Version', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow remarks', + 'type' => 'string', + 'required' => false, + 'example' => 'We don\'t need this old version.', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details; this field is only returned when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. true means success, false means failure.', + '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' => 'Offline Flow Version', + 'translator' => 'machine', + ], + 'OnlineFlowVersion' => [ + 'summary' => 'Online Flow Version', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Remark', + 'type' => 'string', + 'required' => false, + 'example' => 'Let\'s go online.', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. true means success, false means failure.', + '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' => 'Online Flow Version', + 'translator' => 'machine', + ], + 'ReadChatFlow' => [ + 'summary' => 'Retrieve Flow', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Detailed reason for access denial.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true for success, false for failure.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Get Flow Details', + 'translator' => 'machine', + ], + 'ReadChatFlowLogSetting' => [ + 'summary' => 'View chatFlow log settings', + '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' => 'Process code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'Returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Whether the operation was successful. Values: true: success; false: failure.', + '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' => 'View Process Log Settings', + 'translator' => 'machine', + ], + 'ReadFlowVersion' => [ + 'summary' => 'Get Flow Version', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version status.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DRAFT' => 'DRAFT', + 'DELETED' => 'DELETED', + 'ONLINE' => 'ONLINE', + 'OFFLINE' => 'OFFLINE', + ], + 'example' => 'DRAFT', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details; this field is only returned when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Get Flow Version', + 'translator' => 'machine', + ], + 'UpdateChatFlow' => [ + 'summary' => 'Get Process', + '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' => 'Process title', + 'type' => 'string', + 'required' => false, + 'example' => 'Customer Service WhatsApp Auto-Reply Flow', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Process remarks', + 'type' => 'string', + 'required' => false, + 'example' => 'This is Customer Service WhatsApp Auto-Reply Flow', + ], + ], + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Process code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf8c70', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial; this field is only returned when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Update Process', + 'translator' => 'machine', + ], + 'UpdateChatFlowLogSetting' => [ + 'summary' => 'Modify chatFlow log settings', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'Setting ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => 'Log enable status, enum values:'."\n" + .'- ENABLED: Enabled, enables log writing'."\n" + .'- DISABLED: Create or retain related resources, but do not enable log writing'."\n" + .'- DELETED: Delete, and decide whether to delete related resources based on options', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'DISABLED' => 'DISABLED', + 'ENABLED' => 'ENABLED', + 'DELETED' => 'DELETED', + ], + 'example' => 'ENABLED', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied details, this field is returned only when RAM verification fails.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'Returned data object.', + 'type' => 'object', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Whether the operation was successful. Values: true: success; false: failure.', + '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' => 'Update Flow Log Settings', + 'translator' => 'machine', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'UpdateFlowVersion' => [ + 'summary' => 'Update flow version, used for updating the flow DSL on the canvas', + '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' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FlowViewModel', + 'in' => 'query', + 'schema' => [ + 'description' => 'DSL data of the flow version', + 'type' => 'string', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Version remarks', + 'type' => 'string', + 'required' => false, + 'example' => 'Fix Send WhatsApp Message Error', + ], + ], + [ + 'name' => 'BizCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + 'default' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Response' => [ + 'description' => 'Content of the returned data.', + 'type' => 'object', + 'example' => '无', + ], + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Request ID.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true for success, false for failure.', + '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' => 'Update Flow Version for Canvas Flow DSL Update', + 'translator' => 'machine', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '示例值', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '2121-112', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '122', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => 'dgdf5-bvcv**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'RelatedGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '14711522522', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'fdsfdsf-22fk***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1234322333', + ], + 'AccountId' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '181916005005216', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '12456', + ], + ], + [ + 'name' => 'SceneTemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SceneTemplateCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'WhatsappCatagory' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'SceneTemplateName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '131', + ], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'code', + ], + ], + [ + 'name' => 'Permissions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => '11111', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'description' => '', + 'type' => 'object', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '1223-1111', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '154654654654654', + ], + ], + [ + 'name' => 'InstanceId', + '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' => 'ok', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'gfdg435t-hf544**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '154332432432', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'JHGJG-65HFGF**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://public-oss.es**/camera_609.png', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '21432', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Code' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => '3R938***', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'cn', + ], + 'Code' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'ALICOM_OPAAS', + 'default' => '', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '39***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ftete3254***', + 'default' => '', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'hgfh77-gfh55***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '12534653543', + ], + 'AccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1245454654654', + ], + 'PageName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'iwhalecloud', + ], + 'ConnectionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Connected', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Alice', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'EARDGFDGF12****', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'sd2dsd-33*****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '17433243434', + ], + 'PageName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'iwhalecloud-2', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'False', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => 'https://******', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8**9-A94866411B2O'."\n", + ], + 'Data' => [ + 'description' => '', + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-x***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2**9-A94866411B2O'."\n", + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '11', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '7832312', + ], + 'PageName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aaa', + ], + 'DatasetId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '111', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '5435', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A94866***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '1', + ], + 'RequestNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '453645465***', + ], + 'FullPicture' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'N/A', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'successful', + ], + 'RequestId' => [ + 'description' => '', + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'dsfdsf-3jfj***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BeebotInfo' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BeebotInstanceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'instance1', + ], + 'BeebotNamespaceId' => [ + 'description' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '213254324532523', + ], + 'QueueFlag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'HttpFlag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'AccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '176546546464', + ], + 'StatusQueue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AAA', + ], + 'UpQueue' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'BBB', + ], + 'PageName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'iwhaclecloud-2', + ], + 'ConnectionStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'connected', + ], + 'UpCallbackUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP://WWW.***.COM', + ], + 'QueueName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'aaa', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'matrryhtr', + ], + 'StatusCallbackUrl' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'HTTP://WWW.***.COM', + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '2024-09-30T15:53:01+08:00', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'MediaType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'image', + ], + 'Id' => [ + 'description' => '', + 'type' => 'string', + 'example' => '111', + ], + 'FullPicture' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'https://xxxxxxxx'."\n", + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '68', + ], + ], + [ + 'name' => 'RelatedFlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + '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' => '', + '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' => '示例值', + ], + 'RelatedGroupId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '54354**', + ], + 'SpecificTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + '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' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '99', + ], + 'CronExpression' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0 0 4 1/1 * ?', + ], + 'ParamFlag' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Y', + ], + 'BizCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'ddhjdn-dnjdnkdjknd**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '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' => '', + ], + 'example' => '', + ], + 'BusinessAccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'ServiceId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '25644', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + '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' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => '3D2FFEE6-368D-532D-87AA-F45B02DD28B7', + ], + 'Code' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'N/A', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{}', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '46546546546**', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1939848838', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '929399382', + ], + ], + [ + 'name' => 'RequestData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataProcessingOptionsState' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'Purchase', + ], + 'OptOut' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'AppData' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'any', + 'description' => 'data', + 'example' => '{}', + ], + 'example' => '', + ], + 'EventTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1709201870', + ], + 'ExtInfo' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'required' => false, + 'example' => '20029399299', + ], + 'DataProcessingOptions' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => 'data', + 'type' => 'string', + 'required' => false, + 'example' => ' [] ', + ], + 'required' => false, + 'example' => '', + ], + 'MessagingChannel' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'whatsapp', + ], + 'ActionSource' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'business_messaging', + ], + 'DataProcessingOptionsCountry' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100', + ], + 'EventSourceUrl' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + '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' => '', + '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' => '', + 'type' => 'object', + 'properties' => [ + 'ContactMail' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + 'CompanyLegalName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + 'LetterGuarantee' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + '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' => '', + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '14111561****', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'CronExpression', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0 59 9 */1 * ?', + ], + ], + [ + 'name' => 'RelatedGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '114345654645XX', + ], + ], + [ + 'name' => 'RelatedFlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '示例值', + ], + ], + [ + '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' => '', + 'type' => 'string', + 'example' => 'ewtrew-fghdfg43564ZZ', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => 'True', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'xxx-xx**', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'InstanceName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ins', + ], + 'InstanceId' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + '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' => '', + 'type' => 'string', + 'example' => 'xx-xx***', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NONE', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => 'hgfh77-gfh55***', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '42', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + 'TagDescription' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + 'TagId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xx', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AccountCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'example' => 'xis-sx***', + ], + 'Total' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Sendtype' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'trigger', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1743579634000', + ], + 'MailAddressId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Model' => [ + 'description' => '', + 'type' => 'object', + 'example' => '1', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'GetChatFlowMetric' => [ + 'summary' => 'Get ChatFlow Runtime Data', + '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' => 'Business tenant code, default is “ALICOM_OPAAS”.', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ALICOM_OPAAS' => 'ALICOM_OPAAS', + ], + 'example' => 'ALICOM_OPAAS', + ], + ], + [ + 'name' => 'BizExtend', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Business extension information, default is “{}”.', + 'type' => 'object', + 'required' => false, + 'example' => '{}', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => 'Start timestamp in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1751299200', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => 'End timestamp in seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1751385599', + ], + ], + [ + 'name' => 'FlowCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow code.', + 'type' => 'string', + 'required' => false, + 'example' => 'f4912c16943b4dfba44bd6fedacf****', + ], + ], + [ + 'name' => 'FlowVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flow version.', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MetricName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Metric name.', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'nodeUsageStatistics' => 'nodeUsageStatistics', + ], + 'example' => 'nodeUsageStatistics', + ], + ], + [ + 'name' => 'MetricParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Details of access denial.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => 'Error message.', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => 'Unique request ID.', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Data' => [ + 'description' => 'Returned data object.', + 'type' => 'object', + 'example' => '无', + ], + 'Code' => [ + 'description' => 'Status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates whether the operation was successful. Values: true: success; false: failure.', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + ], + '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' => 'Get ChatFlow Runtime Data', + 'translator' => 'machine', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'zh_CN', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'WHATSAPP', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-idk***', + ], + ], + [ + 'name' => 'CategoryChangePaused', + 'in' => 'query', + 'schema' => [ + 'description' => '', + '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' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'Model' => [ + 'description' => '', + 'type' => 'object', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + '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' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-**', + ], + ], + [ + 'name' => 'PageId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '230***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39**', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2030***', + ], + 'AdAccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Alibaba', + ], + 'Currency' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'USD', + ], + 'AdAccountId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '29393****', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + 'CreateMessengerPage' => [ + 'summary' => '嵌入式授权messenger', + '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' => '', + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '2393***', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'CustSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cams-s***', + ], + ], + [ + 'name' => 'BusinessId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '293***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '39***', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + '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"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'cams.ap-southeast-1.aliyuncs.com', + ], + ], +]; |