'1.0', 'info' => ['style' => 'RPC', 'product' => 'cams', 'version' => '2020-06-06'], 'directories' => [ [ 'children' => ['AddChatGroup', 'AddChatGroupInviteLink', 'DeleteChatGroupInviteLink', 'DeleteChatGroupParticipants', 'ListChatGroup', 'UpdateChatGroup', 'DeleteChatGroup'], 'type' => 'directory', 'title' => 'Audience group management', ], [ 'children' => ['SyncMessengerSubscriptionToken', 'SyncMessageCampaign', 'ListMessengerSubscriptionToken', 'ListMessageCampaign', 'ListCustomAudience', 'ListChatGroupParticipants', 'GetMessageCampaignInsights', 'DeleteMessageCampaign', 'CreateMessageCampaign', 'CreateCustomAudience', 'AddCustomAudienceUser'], 'type' => 'directory', 'title' => 'Messenger marketing messages', ], [ 'children' => ['ListInstance', 'QueryInstance'], 'type' => 'directory', 'title' => 'Instance/Space management', ], [ 'children' => ['TriggerChatFlow'], 'type' => 'directory', 'title' => 'ChatFlow', ], [ 'children' => ['CreateFlow', 'ListFlow', 'GetFlow', 'ModifyFlow', 'UpdateFlowJSONAsset', 'GetFlowJSONAssest', 'GetFlowPreviewUrl', 'PublishFlow', 'DeprecateFlow', 'DeleteFlow'], 'type' => 'directory', 'title' => 'Whatsapp Flow', ], [ 'children' => [ 'IsvGetAppId', 'ChatappBindWaba', 'GetPermissionByCode', 'ChatappSyncPhoneNumber', 'AddChatappPhoneNumber', 'GetPhoneNumberVerificationStatus', 'GetChatappVerifyCode', 'ChatappVerifyAndRegister', 'ChatappPhoneNumberRegister', 'ChatappPhoneNumberDeregister', 'QueryWabaBusinessInfo', 'UpdatePhoneWebhook', 'UpdateAccountWebhook', 'QueryPhoneBusinessProfile', 'ModifyPhoneBusinessProfile', 'CreateChatappMigrationInitiate', 'GetMigrationVerifyCode', 'ChatappMigrationVerified', 'ChatappMigrationRegister', 'GetChatappUploadAuthorization', 'GetCommerceSetting', 'UpdateCommerceSetting', 'SyncBusinessAppHistory', ], 'type' => 'directory', 'title' => 'Embedded Signup Related APIs', ], [ 'children' => ['GetWhatsappHealthStatus', 'UpdateConversationalAutomation', 'GetConversationalAutomation', 'GetPhoneEncryptionPublicKey', 'UpdatePhoneEncryptionPublicKey', 'UpdatePhoneMessageQrdl', 'ListPhoneMessageQrdl', 'DeletePhoneMessageQrdl', 'CreatePhoneMessageQrdl', 'QueryChatappPhoneNumbers', 'QueryChatappBindWaba'], 'type' => 'directory', 'title' => 'Phone Management', ], [ 'children' => ['SendChatappMassMessage', 'SendChatappMessage', 'WhatsappCall'], 'type' => 'directory', 'title' => 'Message Sending', ], [ 'children' => ['CreateChatappTemplate', 'ModifyChatappTemplate', 'ListChatappTemplate', 'GetChatappTemplateDetail', 'DeleteChatappTemplate', 'CheckDirectSendMessageSample', 'GetAutoGeneratedTemplate'], 'type' => 'directory', 'title' => 'Template Management', ], [ 'children' => ['ListProductCatalog', 'GetWhatsappConnectionCatalog', 'ListProduct'], 'type' => 'directory', 'title' => 'Product Catalog', ], [ 'children' => ['GetChatappPhoneNumberMetric', 'EnableWhatsappROIMetric', 'GetChatappTemplateMetric', 'RequestWhatsappConversionApi'], 'type' => 'directory', 'title' => 'Statistical Metric', ], [ 'children' => [ 'ListChatappMessage', 'GetPreValidatePhoneId', 'CreateChatFlow', 'CreateChatFlowByImport', 'CreateChatFlowLogSetting', 'CreateFlowVersion', 'DeleteChatFlow', 'DeleteFlowVersion', 'FlowBindPhone', 'FlowRebindPhone', 'FlowUnbindPhone', 'GetChatFlowTemplate', 'ListBindingRelationsForFlowVersion', 'ListChatFlow', 'ListChatFlowTemplate', 'ListFlowNodePrototypeV2', 'ListFlowVersion', 'OfflineFlowVersion', 'OnlineFlowVersion', 'ReadChatFlow', 'ReadChatFlowLogSetting', 'ReadFlowVersion', 'UpdateChatFlow', 'UpdateChatFlowLogSetting', 'UpdateFlowVersion', 'ChatappEmbedSignUp', 'SubmitIsvCustomerTerms', 'AddAuditViberOpen', 'GetViberByRequestNo', 'UpdateAuditRequest', 'CreateInstance', 'DeleteInstance', 'ListWhatAppTemplate', 'UpdateInstance', 'SubmitVerifyCodeResult', ], 'type' => 'directory', 'title' => 'Other', ], [ 'children' => [ 'AddAddressRecoverSuspend', 'AddContacts', 'AddGroup', 'AddMarketingFlow', 'BeeBotAssociate', 'BeeBotChat', 'BindDmAccount', 'BindInstagramPage', 'BindMessengerPage', 'ChangeResourceGroup', 'CopyTemplate', 'CreateMessengerPage', 'CreateWhatsappConversionApi', 'DeleteContacts', 'DeleteContactsByIds', 'DeleteGroupById', 'DeleteInstagramPage', 'DeleteMarketingFlow', 'DeleteMessengerPage', 'GeneratePresignedUrl', 'GetAuditRequestByTypeUnAudit', 'GetChatFlowMetric', 'GetChatappOpenStatus', 'GetChatappPhoneNumberSetting', 'GetCustomerSite', 'GetDownloadExcelList', 'GetFbInstagramPages', 'GetFbMessengerPages', 'GetGroupExist', 'GetPledgeTemplateAddress', 'GetViberPauseTimes', 'GetWhatsappConversionApi', 'ListAllGroups', 'ListBindDmAccount', 'ListDmAccount', 'ListDmTag', 'ListFacebookPosts', 'ListFlowNodeGroup', 'ListInstagramPage', 'ListInstagramPosts', 'ListMarketingFlow', 'ListPageAdAccount', 'ListViberServiceMessage', 'ModifyChatappTemplateProperties', 'MoveContactToGroup', 'OpenChatappService', 'PauseMarketingFLow', 'QueryMMLActive', 'RemoveContactById', 'SyncFlow', 'UnbindDmAccount', 'UpdateContactById', 'UpdateGroupName', 'UpdateMarketingFLow', 'UpdateWabaMmlStatus', ], 'title' => 'Others', 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddAddressRecoverSuspend' => [ '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' => 'The request type.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The customer space ID.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'title' => ''], ], [ 'name' => 'AuditRecord', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The audit record.', 'type' => 'object', 'properties' => [ 'RecoveryDate' => ['description' => 'The recovery date.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'description' => 'The list of international destination countries for messages.', 'type' => 'array', 'items' => ['description' => 'The international destination country for messages.', 'type' => 'string', 'required' => false, 'example' => 'Country', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], 'MessageDestinationCountry' => [ 'description' => 'The list of destination countries for messages.', 'type' => 'array', 'items' => ['description' => 'The destination country for messages.', 'type' => 'string', 'required' => false, 'example' => 'Country', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], 'ApplyReason' => ['description' => 'The reason for the application.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'title' => ''], 'SuspensionDate' => ['description' => 'The suspension date.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值', 'title' => ''], ], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The returned message. A success message is returned if the request succeeds. A failure reason is returned if the request fails.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'example' => '示例值', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" .'- true: Successful.'."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Change destination, resume, or pause', 'summary' => 'Submits a request to change the destination, resume, or pause.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddAddressRecoverSuspend', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => 'Signs up for a Viber account.', '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' => 'The audit result.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => 'example', 'title' => ''], ], [ 'name' => 'AuditRecord', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'ContactMail' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '123@123.com', 'title' => ''], 'CompanyLegalName' => ['description' => 'The legal name of the company.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], 'LetterGuarantee' => ['description' => 'The letter of guarantee.', 'type' => 'string', 'required' => false, 'example' => 'tiCaYNHR8ttt', 'title' => ''], 'IndustryInvolved' => ['description' => 'The industry involved.', 'type' => 'string', 'required' => false, 'example' => 'NFUwytiBnm11', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'type' => 'array', 'items' => ['description' => 'A specific value.', 'type' => 'string', 'required' => false, 'example' => 'MessageDestinationInternationalCountry', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'A list of destination countries/regions for international messages.', 'title' => '', ], 'CompleteAddressOfHeadquarters' => ['description' => 'The complete address of the headquarters.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'MessageEnableDate' => ['description' => 'The date when messaging is enabled.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'BusinessLicenseRegistrationNumber' => ['description' => 'The registration number of the business license.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'CompanyLegalPerson' => ['description' => 'The legal representative of the company.', 'type' => 'string', 'required' => false, 'example' => 'jerry', 'title' => ''], 'CompanyAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyAddress' => ['description' => 'The company address.', 'type' => 'string', 'required' => false, 'example' => 'address', 'title' => ''], 'CompanyAddressTitle' => ['description' => 'The title of the company address.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], ], 'required' => false, 'description' => 'A company address.', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'description' => 'A list of company addresses.', 'title' => '', ], 'CompanyRegisteredCountry' => ['description' => 'The country where the company is registered.', 'type' => 'string', 'required' => false, 'example' => 'cn', 'title' => ''], 'AgeLimit' => ['description' => 'The age limit.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'IndustryDescription' => ['description' => 'A description of the industry.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'WebAddress' => ['description' => 'The website address.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'EnableAutoReply' => ['description' => 'Specifies whether to enable auto-reply.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'BusinessAccountName' => ['description' => 'The name of the business account.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'Logo' => [ 'type' => 'array', 'items' => ['description' => 'A logo.', 'type' => 'string', 'required' => false, 'example' => 'logo1', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'A list of logos.', 'title' => '', ], 'ReplyContent' => ['description' => 'The content of the reply.', 'type' => 'string', 'required' => false, 'example' => 'hello', 'title' => ''], 'CompanyProfile' => ['description' => 'The company profile.', 'type' => 'string', 'required' => false, 'example' => 'CompanyProfile', 'title' => ''], 'CompanyTel' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyTelNumber' => ['description' => 'The company phone number.', 'type' => 'string', 'required' => false, 'example' => '156********', 'title' => ''], 'CompanyTelTitle' => ['description' => 'The title of the company phone number.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], ], 'required' => false, 'description' => 'A single object.', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'description' => 'A list of company phone number objects.', 'title' => '', ], 'MessageDialogueIntroduction' => ['description' => 'The introduction in the message dialog box.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'OtherLetterGuarantee' => ['description' => 'Other letters of guarantee.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'MessageDestinationCountry' => [ 'type' => 'array', 'items' => ['description' => 'The destination country/region of the message.', 'type' => 'string', 'required' => false, 'example' => 'nPHK8uaRo', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'A list of destination countries/regions for messages.', 'title' => '', ], 'MessageSessionName' => ['description' => 'The name of the message session.', 'type' => 'string', 'required' => false, 'example' => 'nPHK8uaRo', 'title' => ''], 'CompanyEnglishName' => ['description' => 'The English name of the company.', 'type' => 'string', 'required' => false, 'example' => '7Pj6', 'title' => ''], 'ContactPhone' => ['description' => 'The phone number of the contact person.', 'type' => 'string', 'required' => false, 'example' => '8615115**777', 'title' => ''], 'ContactPosition' => ['description' => 'The position of the contact person.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'ContactEmail' => ['description' => 'The email address of the contact person.', 'type' => 'string', 'required' => false, 'example' => '7151***5@qq.com', 'title' => ''], 'ContactName' => ['description' => 'The name of the contact person.', 'type' => 'string', 'required' => false, 'example' => 'mary', 'title' => ''], ], 'required' => false, 'example' => '', 'description' => 'The audit record.', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Detailed information about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'A message describing the result of the request.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '2121-112', 'title' => ''], 'Data' => ['description' => 'The response data.', 'type' => 'object', 'example' => '122', 'title' => ''], 'Code' => ['description' => 'The response status code.'."\n" ."\n" .'- `OK`: The request succeeded.'."\n" ."\n" .'- For other values, see [Error Codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Whether the request succeeded.'."\n" ."\n" .'- **true**: The request succeeded.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => 'The response object.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddAuditViberOpen', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddAuditViberOpen', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"2121-112\\",\\n \\"Data\\": 122,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'AddChatGroup' => [ 'summary' => 'Creates an IM group.', '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' => 'The phone number associated with the business account.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The group description.', 'type' => 'string', 'required' => false, 'example' => 'This is a newly created group', 'title' => ''], ], [ 'name' => 'Subject', 'in' => 'query', 'schema' => ['description' => 'The group title.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId or instance ID of the ISV sub-customer, which is the channel ID. Find it on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid value:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> Currently, only the WhatsApp channel type is supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'GroupLink', 'in' => 'query', 'schema' => ['description' => 'The link to the WhatsApp group.', 'type' => 'string', 'required' => false, 'example' => 'https://t.me/testgroup', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'UniqueCode' => ['description' => 'The unique request code.', 'type' => 'string', 'example' => '8938****', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The response status code. Valid values:'."\n" ."\n" .'- `OK`: The request was successful.'."\n" ."\n" .'- For other error codes, see the [error code list](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates if the API call succeeded. Valid values:'."\n" ."\n" .'- **true**: The API call was successful.'."\n" ."\n" .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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\\": true\\n}","type":"json"}]', 'title' => 'AddChatGroup', 'description' => '>'."\n" ."\n" .'Creating IM groups via the API is a feature in closed beta testing by Meta. Please contact your account manager to be added to the allowlist.'."\n" ."\n" .'>'."\n" ."\n" .'- You can only create an IM group by calling this API.'."\n" ."\n" .'- After creating an IM group, you can call the [AddChatGroupInviteLink](~~3019211~~) API to generate an invite link.'."\n" ."\n" .'- For the WhatsApp channel type, an IM group is limited to eight members.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], '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' => 'The business phone number. You can view the business phone number by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => [ 'description' => 'The channel type. Valid values:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> Only the WhatsApp channel type is supported.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => '', ], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID. You can view the group ID by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'E93kdk****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-x***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'InviteLink' => ['description' => 'The invite link.', 'type' => 'string', 'example' => 'https://chat.whatsapp.com/****', 'title' => ''], 'Code' => ['description' => 'The response code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Add an IM group invite link', 'summary' => 'Adds an invite link for an IM group.', 'description' => '>Adding IM group invite links through the API is a Meta beta feature. Contact your account manager to apply for access.>'."\n" ."\n" .'- Before calling this operation, make sure that you have a successfully created IM group.'."\n" ."\n" .'- If you do not have a successfully created IM group, call the [AddChatGroup](~~2998429~~) operation to create one.'."\n" ."\n" .'- After you call this operation to add an IM group invite link, you can use the link to invite members to join the IM group.'."\n" ."\n" .'- Currently, members can join an IM group only through an invite link.'."\n" ."\n" .'- The maximum number of members in a WhatsApp group is 8.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddChatGroupInviteLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'AddChatappPhoneNumber' => [ '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' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '1380000****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '93928389****', 'title' => ''], ], [ 'name' => 'Cc', 'in' => 'query', 'schema' => ['description' => 'The country code.', 'type' => 'string', 'required' => true, 'example' => '86', 'title' => ''], ], [ 'name' => 'PreValidateId', 'in' => 'query', 'schema' => ['description' => 'The pre-validated phone number.'."\n" .'> This parameter is deprecated.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '1020****', 'title' => ''], ], [ 'name' => 'VerifiedName', 'in' => 'query', 'schema' => ['description' => 'The display name of the phone number.', 'type' => 'string', 'required' => true, 'example' => 'Alibaba', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Add whatsApp phone number', 'summary' => 'Adds a phone number to a WABA.', 'description' => 'The China site (Chinese mainland) QPS limit for a single user on this API is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2024-09-05T03:40:37.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddChatappPhoneNumber'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:AddChatappPhoneNumber', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'AddContacts' => [ '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' => 'The name of the contact.', 'type' => 'string', 'required' => false, 'example' => 'mary', 'title' => ''], ], [ 'name' => 'ContactDetails', 'in' => 'query', 'schema' => ['description' => 'The description of the contact.', 'type' => 'string', 'required' => false, 'example' => '15111111111', 'title' => ''], ], [ 'name' => 'Country', 'in' => 'query', 'schema' => ['description' => 'The country.', 'type' => 'string', 'required' => false, 'example' => 'China', 'title' => ''], ], [ 'name' => 'NeedUpdate', 'in' => 'query', 'schema' => ['description' => 'Indicates whether the back-to-origin IP address whitelist needs to be updated. This parameter returns true when the current back-to-origin IP address whitelist differs from the latest back-to-origin IP address whitelist.'."\n" ."\n" .'- true: The whitelist needs to be updated.'."\n" .'- false: The whitelist does not need to be updated.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Groups', 'in' => 'query', 'schema' => ['description' => 'The user group information.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The file path.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'title' => ''], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => ['description' => 'The business code.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'default' => '', 'title' => ''], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: an empty collection.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Add contact', 'summary' => 'Edits a contact - add contact.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddContacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'AddCustomAudienceUser' => [ 'summary' => 'Adds users to a custom audience.', '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' => 'The space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'required' => true, 'example' => '239**', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Meta ad account.', 'type' => 'string', 'required' => true, 'example' => '3939**', 'title' => ''], ], [ 'name' => 'CustomAudienceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom audience.', 'type' => 'string', 'required' => true, 'example' => '399**', 'title' => ''], ], [ 'name' => 'Users', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Email' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'Example', 'title' => ''], 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => 'Example', 'title' => ''], ], 'required' => false, 'description' => 'An object.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', 'description' => 'A list of users.', 'title' => '', ], ], [ 'name' => 'EstimatedNumTotal', 'in' => 'query', 'schema' => ['description' => 'The estimated total number of users.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26', 'title' => ''], ], [ 'name' => 'BatchLastFlag', 'in' => 'query', 'schema' => ['description' => 'Indicates whether this is the last batch of data.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39**', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AddCustomAudienceUser', 'description' => 'After users are submitted to a custom audience, Meta matches them. If fewer than 100 users are matched, Meta discards the data. This prevents phone numbers from being linked directly to user tokens. Each API call supports up to 10,000 user records.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddCustomAudienceUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"39**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'AddGroup' => [ 'summary' => 'Adds a group.', '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' => 'The group name.', 'type' => 'string', 'required' => true, 'example' => 'testgroup', 'default' => '', 'title' => ''], ], [ 'name' => 'ContactName', 'in' => 'query', 'schema' => ['description' => 'The contact name.', 'type' => 'string', 'required' => false, 'example' => 'mary', 'title' => ''], ], [ 'name' => 'ContactDetails', 'in' => 'query', 'schema' => ['description' => 'The contact description.', 'type' => 'string', 'required' => false, 'example' => '15111111111', 'title' => ''], ], [ 'name' => 'Country', 'in' => 'query', 'schema' => ['description' => 'The country.', 'type' => 'string', 'required' => false, 'example' => 'China', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The file path.', 'type' => 'string', 'required' => false, 'example' => 'src/main/resources/config/promql_node.yaml', 'title' => ''], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => ['description' => 'The business tenant code.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'default' => '', 'title' => ''], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The prompt message. This parameter has a value when an exception is returned.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dgdf5-bvcv**', 'title' => ''], 'Data' => ['description' => 'The returned data object.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Add a group', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'ActivityDesc', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'ExecutionType', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'CronExpression', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'RelatedGroupId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '43', 'description' => '', 'title' => ''], ], [ 'name' => 'RelatedFlowCode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'RelatedFlowName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '示例值', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'BeeBotAssociate' => [ 'summary' => 'Associates FAQs in the knowledge base.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '155449', 'abilityTreeNodes' => ['FEATUREcamsG8AUDM'], ], 'parameters' => [ [ 'name' => 'ChatBotInstanceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of a bot instance.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'IsvCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ISV verification code, which is used to verify whether the user is authorized by ISV.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ksiekdki39ksks93939'], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the session, which is used to identify the session and store context information in the session.'."\n", 'type' => 'string', 'required' => false, 'example' => '2334324234'], ], [ 'name' => 'Perspective', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of codes for answers from different perspectives.'."\n", 'type' => 'array', 'items' => ['description' => 'The code for invoking answers from different perspectives under the same knowledge title.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vEJnjV37Ae', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'RecommendNum', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of recommended questions. The value ranges from 1 to 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'example' => '3'], ], [ 'name' => 'Utterance', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The input of the visitor.'."\n", 'type' => 'string', 'required' => false, 'example' => '你好'], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['title' => '', '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' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Code' => ['title' => '', 'description' => 'If OK is returned, the request is successful.'."\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' => [ 'MessageId' => ['title' => '', 'description' => 'The ID of the response message.'."\n", 'type' => 'string', 'example' => '1eb47d7a1706429081e90c83c62c2f00'], 'SessionId' => ['title' => '', 'description' => 'The ID of the session.'."\n", 'type' => 'string', 'example' => '93f11165a2a24289a6f869760e8cb3f3'], 'Associate' => [ 'description' => 'The list of associated recommendations.'."\n", 'type' => 'array', 'items' => [ 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ 'Meta' => ['title' => '', 'description' => 'The metadata.'."\n", 'type' => 'string', 'example' => '{}'], 'Title' => ['title' => '', 'description' => 'The title of the related question.'."\n", 'type' => 'string', 'example' => '公积金提取的政策'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'The access denied for detailed information.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'BeeBotAssociate', 'description' => 'You can call this operation up to 100 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", 'changeSet' => [ ['createdAt' => '2025-07-03T02:41:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:29:39.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-10-12T01:57:01.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"MessageId\\": \\"1eb47d7a1706429081e90c83c62c2f00\\",\\n \\"SessionId\\": \\"93f11165a2a24289a6f869760e8cb3f3\\",\\n \\"Associate\\": [\\n {\\n \\"Meta\\": \\"{}\\",\\n \\"Title\\": \\"公积金提取的政策\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"无\\"\\n}","type":"json"}]', ], 'BeeBotChat' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '155448', 'abilityTreeNodes' => ['FEATUREcamsG8AUDM'], ], 'parameters' => [ [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the related knowledge.'."\n", 'description' => 'The title of the related knowledge.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en'], ], [ 'name' => 'Utterance', 'in' => 'formData', 'schema' => ['title' => 'The category of the knowledge.'."\n", 'description' => 'The title of the hit question.'."\n", 'type' => 'string', 'required' => true, 'example' => '659216218162179'], ], [ 'name' => 'IsvCode', 'in' => 'formData', 'schema' => ['title' => 'The content of the hit question.'."\n", 'description' => 'The source of the answer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ksiekdki39ksks93939'], ], [ 'name' => 'ChatBotInstanceId', 'in' => 'formData', 'schema' => ['title' => 'The ID of the hit question in the knowledge base.'."\n", 'description' => 'Indicates whether the answer is in plain text or rich text.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'KnowledgeId', 'in' => 'formData', 'schema' => ['title' => 'The text. When AnswerType is set to Text, the Text object is returned by the bot for this parameter.'."\n", 'description' => 'The hit statement.'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'IntentName', 'in' => 'formData', 'schema' => ['title' => 'The name of the dialog. When AnswerSource is set to BotFramework, a value is returned for this parameter.'."\n", 'description' => 'The source of the answer.'."\n", 'type' => 'string', 'required' => false, 'example' => 'intent'], ], [ 'name' => 'SenderId', 'in' => 'formData', 'schema' => ['title' => 'The information about the slot.'."\n", 'description' => 'The information about the slot.'."\n", 'type' => 'string', 'required' => false, 'example' => '861500000000'], ], [ 'name' => 'SenderNick', 'in' => 'formData', 'schema' => ['title' => 'The specific value.'."\n", 'description' => 'Beijing'."\n", 'type' => 'string', 'required' => false, 'example' => 'nick'], ], [ 'name' => 'Perspective', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => 'The original value.'."\n", 'description' => 'Beijing'."\n", 'type' => 'array', 'items' => ['description' => 'The name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'u6Yvizzjba', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'VendorParam', 'in' => 'formData', 'style' => 'json', 'schema' => ['title' => 'Indicates whether the slot is hit.'."\n", 'description' => 'The node name. When AnswerSource is set to BotFramework, a value is returned for this parameter.'."\n", 'type' => 'object', 'required' => false, 'example' => '{\\"skills\\":\\"chat_search\\",\\"accessToken\\":\\"73f4d5c8e8c334d9b538890bca68ac9a\\",\\"senderStaffId\\":\\"1697204021326\\",\\"senderCorpId\\":\\"dingee291fb2828058b9\\"}'], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['title' => 'The intent name. When AnswerSource is set to BotFramework, a value is returned for this parameter.'."\n", 'description' => 'The metadata.'."\n", 'type' => 'string', 'required' => false, 'example' => '293483938849493'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => 'The passthrough parameter. When AnswerSource is set to BotFramework, a value is returned for this parameter.'."\n", 'description' => 'The passthrough parameter.'."\n", 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Code' => ['title' => 'The title of the chitchat.'."\n", 'description' => 'The content of the text message.'."\n", 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => 'The node ID. When AnswerSource is set to BotFramework, a value is returned for this parameter.'."\n", 'description' => 'Indicates whether the answer is in plain text or rich text.'."\n", 'type' => 'string', 'example' => 'none'], 'Data' => [ 'description' => 'The list of the recommended knowledge. When AnswerType is set to Recommend, the list of the recommended knowledge is returned by the bot for this parameter.'."\n", 'type' => 'object', 'properties' => [ 'MessageId' => ['title' => 'The recommended knowledge.'."\n", 'description' => 'The ID of the recommended knowledge.'."\n", 'type' => 'string', 'example' => 'ab6be8af-cee4-40c3-9919-2ac7461d7d98'], 'SessionId' => ['title' => 'The title of the recommended knowledge. Valid values: the entity in graph-based question answering, the knowledge title in knowledge-based question answering, and the column value in table-based question answering.'."\n", 'description' => 'The source of the recommended answer.'."\n", 'type' => 'string', 'example' => '1234'], 'Messages' => [ 'title' => 'The type of the answer.'."\n", 'description' => 'The source of the recommended answer. When AnswerType is set to Recommend, a value is returned for this parameter.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Knowledge' => [ 'title' => '', 'description' => 'When AnswerType is Knowledge, this field contains the Knowledge object returned by the robot.', 'type' => 'object', 'properties' => [ 'HitStatement' => ['title' => '', 'description' => 'Hit statement.', 'type' => 'string', 'example' => '公积金'], 'Summary' => ['title' => '', 'description' => 'Introduction to hit problems.', 'type' => 'string', 'example' => '公积金提取'], 'RelatedKnowledges' => [ 'title' => '', 'description' => 'Related knowledge list.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['title' => '', 'description' => 'The ID of knowledge associated with knowledge.', 'type' => 'string', 'example' => '735899'], 'Title' => ['title' => '', 'description' => 'The title of related knowledge.', 'type' => 'string', 'example' => '公积金提取'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Category' => ['title' => '', 'description' => 'Knowledge category.', 'type' => 'string', 'example' => '公积金'], 'Title' => ['title' => '', 'description' => 'Hit the title of the problem.', 'type' => 'string', 'example' => '公积金提取'], 'Content' => ['title' => '', 'description' => 'Hit the content of the problem.', 'type' => 'string', 'example' => '公积金提取，请在首页搜索公积金提取，提交办事的表单'], 'AnswerSource' => ['title' => '', 'description' => 'Distinguish answer types.', 'type' => 'string', 'example' => 'KnowledgeBase'], 'Id' => ['title' => '', 'description' => 'The ID of the hit problem in the knowledge base.', 'type' => 'string', 'example' => '735898'], 'ContentType' => [ 'title' => '', 'description' => 'Indication of plain/rich text answers.', 'type' => 'string', 'example' => 'PLAIN_TEXT', 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本'], ], ], 'example' => '', ], 'Text' => [ 'title' => '', 'description' => 'When AnswerType is Text, this field contains the Text object returned by the robot.', 'type' => 'object', 'properties' => [ 'HitStatement' => ['title' => '', 'description' => 'Hit statement.', 'type' => 'string', 'example' => '查天气'], 'DialogName' => ['title' => '', 'description' => 'When AnswerSource is BotFramework, this field returns the name of the dialogue unit.', 'type' => 'string', 'example' => '示例_查天气'], 'AnswerSource' => [ 'title' => '', 'description' => 'Distinguish answer types.', 'type' => 'string', 'example' => 'BotFramework', 'enum' => ['ChitChat：闲聊', 'BotFramework：对话工厂', 'NO_ANSWER：无答案', 'MACHINE_READ：机器阅读', 'CardAnswer：卡片答案', 'SENSITIVE_WORD： 全局敏感词', 'COMMANDS：系统指令', 'TABLEQA：表格问答'], ], 'Slots' => [ 'title' => '', 'description' => 'Slot information list.', 'type' => 'array', 'items' => [ 'description' => 'Slot information.', 'type' => 'object', 'properties' => [ 'Value' => ['description' => 'Specific values.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Origin' => ['description' => 'Original value.', 'type' => 'string', 'example' => '北京', 'title' => ''], 'Name' => ['description' => 'Name.', 'type' => 'string', 'example' => '查天气意图.city', 'title' => ''], 'Hit' => ['description' => 'Whether it hits.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'NodeName' => ['title' => '', 'description' => 'When AnswerSource is BotFramework, this field returns the node name.', 'type' => 'string', 'example' => '示例_查天气.查天气填槽.__city'], 'IntentName' => ['title' => '', 'description' => 'When AnswerSource is BotFramework, this field returns the intent name.', 'type' => 'string', 'example' => '查天气意图'], 'MetaData' => ['description' => 'Metadata.', 'type' => 'string', 'example' => '[[{\\"columnName\\":\\"姓名\\",\\"stringValue\\":\\"王珊珊\\"}]]', 'title' => ''], 'ExternalFlags' => ['title' => '', 'description' => 'When AnswerSource is BotFramework, this field returns a transparent parameter.', 'type' => 'object', 'example' => ''], 'Ext' => ['title' => '', 'description' => 'This field returns transparent parameters.', 'type' => 'object', 'example' => ''], 'UserDefinedChatTitle' => ['title' => '', 'description' => 'Custom Chat Topic Title.', 'type' => 'string', 'example' => '问候'], 'Content' => ['title' => '', 'description' => 'The content of the text message.', 'type' => 'string', 'example' => '请问您要查哪里的天气？'], 'NodeId' => ['title' => '', 'description' => 'When AnswerSource is BotFramework, this field returns the node ID.', 'type' => 'string', 'example' => '1410-c7a72a78.__city'], 'ContentType' => [ 'title' => '', 'description' => 'Indication of plain/rich text answers.', 'type' => 'string', 'example' => 'PLAIN_TEXT', 'enum' => ['PLAIN_TEXT：纯本文', 'RICH_TEXT: 富文本', 'CARD_TEMPLATE：卡片模版'], ], ], 'example' => '', ], 'Recommends' => [ 'title' => '', 'description' => 'When AnswerType is Recommended, this field contains a list of Recommendations returned by the robot.', 'type' => 'array', 'items' => [ 'description' => 'Recommended object.', 'type' => 'object', 'properties' => [ 'KnowledgeId' => ['title' => '', 'description' => 'Clarify the knowledge ID.', 'type' => 'string', 'example' => '4548'], 'Title' => ['title' => '', 'description' => 'Clarify the content, which may be the entities of graph Q&A, the knowledge titles of knowledge Q&A, or the column values of table Q&A.', 'type' => 'string', 'example' => '测试纯文本'], 'AnswerSource' => [ 'title' => '', 'description' => 'Clarify the identification of the source.', 'type' => 'string', 'example' => 'KNOWLEDGE', 'enum' => ['Knowledge：FAQ标题', 'BotFramework：对话工厂'], ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'AnswerType' => [ 'title' => '', 'description' => 'The type of this message.', 'type' => 'string', 'example' => 'Text', 'enum' => ['Text：文本', 'Recommend：澄清或者反问', 'Knowledge：知识库知识直出', 'cardAnswer：卡片工坊的卡片答案'], ], 'AnswerSource' => [ 'title' => '', 'description' => 'When AnswerType is Recommended, this field indicates the source of the recommended answer.', 'type' => 'string', 'example' => 'KNOWLEDGE', 'enum' => ['KNOWLEDGE：知识问答', 'INTENT_FAQ_CLARIFY：FAQ和对话工厂混合澄清', 'BotFramework：对话工厂澄清', 'TABLEQA：表格问答'], ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'Access denied for detailed information.', 'type' => 'string', 'example' => '无', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'BeeBotChat', 'summary' => 'Conducts sessions with the bot based on its unique identifier (ID).', 'description' => 'The ID of the session.'."\n", 'changeSet' => [ ['createdAt' => '2025-07-03T02:41:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:29:40.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-10-12T01:57:01.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"none\\",\\n \\"Data\\": {\\n \\"MessageId\\": \\"ab6be8af-cee4-40c3-9919-2ac7461d7d98\\",\\n \\"SessionId\\": \\"1234\\",\\n \\"Messages\\": [\\n {\\n \\"Knowledge\\": {\\n \\"HitStatement\\": \\"公积金\\",\\n \\"Summary\\": \\"公积金提取\\",\\n \\"RelatedKnowledges\\": [\\n {\\n \\"KnowledgeId\\": \\"735899\\",\\n \\"Title\\": \\"公积金提取\\"\\n }\\n ],\\n \\"Category\\": \\"公积金\\",\\n \\"Title\\": \\"公积金提取\\",\\n \\"Content\\": \\"公积金提取，请在首页搜索公积金提取，提交办事的表单\\",\\n \\"AnswerSource\\": \\"KnowledgeBase\\",\\n \\"Id\\": \\"735898\\",\\n \\"ContentType\\": \\"PLAIN_TEXT\\"\\n },\\n \\"Text\\": {\\n \\"HitStatement\\": \\"查天气\\",\\n \\"DialogName\\": \\"示例_查天气\\",\\n \\"AnswerSource\\": \\"BotFramework\\",\\n \\"Slots\\": [\\n {\\n \\"Value\\": \\"北京\\",\\n \\"Origin\\": \\"北京\\",\\n \\"Name\\": \\"查天气意图.city\\",\\n \\"Hit\\": false\\n }\\n ],\\n \\"NodeName\\": \\"示例_查天气.查天气填槽.__city\\",\\n \\"IntentName\\": \\"查天气意图\\",\\n \\"MetaData\\": \\"[[{\\\\\\\\\\\\\\"columnName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"姓名\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"stringValue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"王珊珊\\\\\\\\\\\\\\"}]]\\",\\n \\"ExternalFlags\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Ext\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"UserDefinedChatTitle\\": \\"问候\\",\\n \\"Content\\": \\"请问您要查哪里的天气？\\",\\n \\"NodeId\\": \\"1410-c7a72a78.__city\\",\\n \\"ContentType\\": \\"PLAIN_TEXT\\"\\n },\\n \\"Recommends\\": [\\n {\\n \\"KnowledgeId\\": \\"4548\\",\\n \\"Title\\": \\"测试纯文本\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\"\\n }\\n ],\\n \\"AnswerType\\": \\"Text\\",\\n \\"AnswerSource\\": \\"KNOWLEDGE\\"\\n }\\n ]\\n },\\n \\"AccessDeniedDetail\\": \\"无\\"\\n}","type":"json"}]', 'translator' => 'machine', ], 'BindDmAccount' => [ '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' => 'The SpaceId of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'AccountCode', 'in' => 'query', 'schema' => ['description' => 'The account code.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值示例值', 'title' => ''], ], [ 'name' => 'ExtendAttr', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The extended attributes.', 'type' => 'object', 'properties' => [ 'SendType' => ['description' => 'The send type.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], 'required' => true, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '示例值', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Associate a DM account', 'summary' => 'Associates a DM account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:BindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'BindInstagramPage' => [ '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' => 'The page ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '14711522522', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => '示例值', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['description' => 'The region of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'default' => 'ap-southeast-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'fdsfdsf-22fk***', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The current page ID.', 'type' => 'string', 'example' => '1234322333', 'title' => ''], 'AccountId' => ['description' => 'The account ID.', 'type' => 'string', 'example' => '13243543543', 'title' => ''], 'PageName' => ['description' => 'The page name.', 'type' => 'string', 'example' => 'iwhalecloud', 'title' => ''], 'ConnectionStatus' => ['description' => 'The connection status.', 'type' => 'string', 'example' => 'connected', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Associate a page with an instance', 'summary' => 'Associates a page with an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:BindInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '181916005005216', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'ap-southeast-1', 'default' => 'ap-southeast-1', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'ok', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'DSFDS-8FSDFS**', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['type' => 'string', 'example' => '1654543543543', 'description' => '', 'title' => ''], 'PageName' => ['type' => 'string', 'example' => 'iwhalecloud', 'description' => '', 'title' => ''], 'ConnectionStatus' => ['type' => 'string', 'example' => 'CONNECTED', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'ok', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:BindMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], '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' => ['type' => 'string', 'required' => false, 'default' => 'Instance', 'title' => '', 'description' => '', 'example' => 'template'], ], [ 'name' => 'ResourceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'cas-ivauto-hppr74'], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '-1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'NoPermission.ChangeResourceGroup', 'errorMessage' => 'You are not authorized to change resourcegroup', 'description' => ''], ['errorCode' => 'MissingParameter.RegionId', 'errorMessage' => 'The RegionId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'MissingParameter.ResourceId', 'errorMessage' => 'The ResourceId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'MissingParameter.ResourceGroupId', 'errorMessage' => 'The ResourceGroupId parameters that are required for processing this request are missing', 'description' => ''], ['errorCode' => 'InvalidResourceGroup', 'errorMessage' => 'The specified ResourceGroupId is invalid', 'description' => ''], ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred while processing your request', 'description' => ''], ['errorCode' => 'ResourceNotFound', 'errorMessage' => ' The specified resource is not found', 'description' => ''], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\"\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ChatappBindWaba' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '161150', 'abilityTreeNodes' => ['FEATUREcams2DCA0B'], ], 'parameters' => [ [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['description' => 'waba Id。', 'type' => 'string', 'required' => true, 'example' => '33993***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied detail.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'CustSpaceId' => ['description' => 'The customer space ID.', 'type' => 'string', 'example' => 'C0202939293****', 'title' => ''], 'WabaId' => ['description' => 'waba Id。', 'type' => 'string', 'example' => '293982****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Bind WABA', 'summary' => 'Binds a WhatsApp Business Account (WABA) through the northbound interface.', 'description' => 'The per-user QPS limit for this API is 10 calls per second. If this limit is exceeded, API calls will be throttled, which may affect your business. Call this operation at a reasonable frequency.', 'changeSet' => [ ['createdAt' => '2023-07-04T11:29:40.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappBindWaba'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappBindWaba', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ChatappEmbedSignUp' => [ 'summary' => 'This embedded API is not required if you use v2 of the embedded software development kit (SDK).', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'InputToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The input token.', 'type' => 'string', 'required' => true, 'example' => 'Example value Example value'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => '无'], 'Wabas' => [ 'description' => 'A list of WhatsApp Business Accounts (WABAs).', 'type' => 'array', 'items' => [ 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => 'WabaId', 'description' => 'The WABA ID.', 'type' => 'string', 'example' => '2939933992****'], 'Name' => ['title' => 'Waba Name', 'description' => 'The WABA name.', 'type' => 'string', 'example' => 'Alibaba'], 'Currency' => ['title' => '', 'description' => 'The currency.', 'type' => 'string', 'example' => 'USD'], 'AccountReviewStatus' => ['title' => '', 'description' => 'The review status of the WABA.', 'type' => 'string', 'example' => 'VERIFIED'], 'MessageTemplateNamespace' => ['title' => '', 'description' => 'The namespace of the message template.', 'type' => 'string', 'example' => 'alals-lsslls-slslsos-****'], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => '无'], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => '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\\": \\"无\\",\\n \\"Wabas\\": [\\n {\\n \\"Id\\": \\"2939933992****\\",\\n \\"Name\\": \\"Alibaba\\",\\n \\"Currency\\": \\"USD\\",\\n \\"AccountReviewStatus\\": \\"VERIFIED\\",\\n \\"MessageTemplateNamespace\\": \\"alals-lsslls-slslsos-****\\"\\n }\\n ],\\n \\"AccessDeniedDetail\\": \\"无\\"\\n}","type":"json"}]', 'title' => 'ChatappEmbedSignUp', 'description' => 'The queries per second (QPS) limit for this API is 10 per user. If you exceed this limit, your API calls will be throttled. This may impact your business. To avoid service disruption, call the API at a reasonable rate.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:17.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'ChatappMigrationRegister' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '164337', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '8613800****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Migrate phone number registration', 'summary' => 'Migrates a phone number registration.', 'description' => 'The queries per second (QPS) limit for this operation is 10 calls per second per user. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:42.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappMigrationRegister'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappMigrationRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'ChatappMigrationVerified' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '164328', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '86138000****', 'title' => ''], ], [ 'name' => 'VerifyCode', 'in' => 'query', 'schema' => ['description' => 'The verification code.', 'type' => 'string', 'required' => true, 'example' => '8287**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'Id' => ['description' => 'The phone number ID.', 'type' => 'string', 'example' => '8282889****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Verify phone number for migration', 'summary' => 'Verifies a phone number for migration.', 'description' => 'The China Message Service API has a single-user QPS limit of 10 calls per second. If this limit is exceeded, throttling is triggered, which may affect your business. Manage your calls appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:16.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:42.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappMigrationVerified'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappMigrationVerified', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ChatappPhoneNumberDeregister' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '192466', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '86189********', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-sdkj31kj32lk3j', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Deregister a whatsApp phone number', 'summary' => 'Deregisters a phone number from WABA.', 'description' => 'The China Mainland site (Chinese) QPS limit for a single user for this API is 10 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Manage your calls appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappPhoneNumberDeregister'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappPhoneNumberDeregister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'ChatappPhoneNumberRegister' => [ '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.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '93928389****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Register phone number', 'summary' => 'Registers a phone number through the northbound interface.', 'description' => 'The China Mainland Messaging API has a single-user QPS limit of 10 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2023-07-04T11:29:43.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappPhoneNumberRegister'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappPhoneNumberRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ChatappSyncPhoneNumber' => [ '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 SpaceId of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849493****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'PhoneNumbers' => [ 'description' => 'The list of phone numbers.', 'type' => 'array', 'items' => [ 'description' => 'The object.', 'type' => 'object', 'properties' => [ 'VerifiedName' => ['description' => 'The verified name of the phone number.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'Status' => [ 'description' => 'The status of the phone number.', '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', ], 'type' => 'string', 'example' => 'PENDING', 'title' => '', ], 'UpQueue' => ['description' => 'The upstream MSMQ.', 'type' => 'string', 'example' => 'alicom-0939****-queue', 'title' => ''], 'NameStatus' => ['description' => 'The name review status.', 'type' => 'string', 'example' => 'Approval', 'title' => ''], 'MessagingLimitTier' => [ 'description' => 'The messaging limit tier of the phone number.', 'enumValueTitles' => ['TIER_100K' => '100000', 'TIER_UNLIMITED' => 'unlimited', 'TIER_250' => '250', 'TIER_1K' => '1000', 'TIER_50' => '50', 'TIER_10K' => '10000'], 'type' => 'string', 'example' => 'TIER_10K', 'title' => '', ], 'StatusCallbackUrl' => ['description' => 'The callback URL for status reports.', 'type' => 'string', 'example' => 'https://www.alibaba.com/status', 'title' => ''], 'QualityRating' => [ 'description' => 'The quality rating of the phone number.', 'enumValueTitles' => ['RED' => 'RED', 'YELLOW' => 'YELLOW', 'GREEN' => 'GREEN'], 'type' => 'string', 'example' => 'GREEN', 'title' => '', ], 'CodeVerificationStatus' => [ 'description' => 'The verification status. Valid values:'."\n" ."\n" .'- REVOKED: The verification request is revoked.'."\n" .'- MORE_INFORMATION_REQUESTED: More information is required.'."\n" .'- VERIFIED: The verification is passed.'."\n" .'- REJECTED: The verification is rejected.', 'enumValueTitles' => ['REVOKED' => 'The verification request is revoked.', 'MORE_INFORMATION_REQUESTED' => 'More information is required.', 'VERIFIED' => 'The verification is passed.', 'REJECTED' => 'The verification is rejected.'], 'type' => 'string', 'example' => 'VERIFIED', 'title' => '', ], 'NewNameStatus' => ['description' => 'The review status of the new name.', 'type' => 'string', 'example' => 'Approval', 'title' => ''], 'CallingConfigure' => [ 'type' => 'object', 'properties' => [ 'Calling' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'string', 'example' => 'ENABLED', 'description' => '', 'title' => ''], 'CallHours' => [ 'type' => 'object', 'properties' => [ 'Status' => ['type' => 'string', 'example' => 'ENABLED', 'description' => '', 'title' => ''], 'HolidaySchedule' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'EndTime' => ['type' => 'string', 'example' => '2359', 'description' => '', 'title' => ''], 'StartTime' => ['type' => 'string', 'example' => '0000', 'description' => '', 'title' => ''], 'Date' => ['type' => 'string', 'example' => '2026-01-01', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'TimezoneId' => ['type' => 'string', 'example' => 'Asia/Shanghai', 'description' => '', 'title' => ''], 'WeeklyOperatingHours' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'OpenTime' => ['type' => 'string', 'example' => '0000', 'description' => '', 'title' => ''], 'DayOfWeek' => ['type' => 'string', 'example' => 'MONDAY', 'description' => '', 'title' => ''], 'CloseTime' => ['type' => 'string', 'example' => '2359', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], ], 'example' => '', 'description' => '', 'title' => '', ], 'CallbackPermissionStatus' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'CallIconVisibility' => ['type' => 'string', 'example' => 'DEFAULT', 'description' => '', 'title' => ''], ], 'example' => '', 'description' => '', 'title' => '', ], 'MaxTalkTime' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'description' => '', 'title' => ''], 'CallingCallbackUrl' => ['type' => 'string', 'example' => 'http://aliyun.com', 'description' => '', 'title' => ''], ], 'example' => '', 'description' => '', 'title' => '', ], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'StatusQueue' => ['description' => 'The status report queue.', 'type' => 'string', 'example' => 'alicom-0939****-queue', 'title' => ''], 'IsOfficial' => ['description' => 'Indicates whether the phone number is OBA-certified.', 'type' => 'string', 'example' => 'N', 'title' => ''], 'UpCallbackUrl' => ['description' => 'The callback URL for upstream messages.', 'type' => 'string', 'example' => 'https://www.alibaba.com/inbound'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- A value of OK indicates that the request is successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call is successful. Valid values:'."\n" .'- **true**: The call is successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Sync phone number information', 'summary' => 'Synchronizes phone number information.', 'description' => 'The China-specific QPS limit for this API is 10 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.', 'changeSet' => [ ['createdAt' => '2023-07-04T11:29:43.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappSyncPhoneNumber'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ChatappSyncPhoneNumber', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ChatappVerifyAndRegister' => [ 'summary' => 'Verifies a verification code and registers through the northbound interface.', '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 SpaceId of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '2938929938****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'VerifyCode', 'in' => 'query', 'schema' => ['description' => 'The verification code.', 'type' => 'string', 'required' => true, 'example' => '1234**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Code' => ['description' => 'The status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Verify phone number and register', 'description' => 'The queries per second (QPS) limit for this API is 10 calls per second per user. If this limit is exceeded, API calls are throttled, which may affect your business. Call this API appropriately.', 'changeSet' => [ ['createdAt' => '2023-07-04T11:29:44.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappVerifyAndRegister'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappVerifyAndRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CheckDirectSendMessageSample' => [ 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => [ 'description' => 'The direct-send content type. Valid values:'."\n" .'- interactive'."\n" .'- text', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'interactive', 'title' => '', ], ], [ 'name' => 'Interactive', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The message body of the interactive type.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The interactive content.', 'type' => 'any', 'example' => '{"type": "cta_url", "header": { "type": "text","text": "Order Update"}, "body": { "text": "Your order is ready."}, "action": { "name": "cta_url", "parameters": { "display_text": "View Order","url": "https://example.com" } } }', 'title' => ''], 'example' => '', 'title' => '', ], ], [ 'name' => 'Text', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The message body of the text content.', 'type' => 'object', 'required' => false, 'example' => '{"text": "This is a direct send message"}', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-xx**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Category' => ['description' => 'The WhatsApp template category. Valid values:'."\n" ."\n" .'- **UTILITY**: transaction-related.'."\n" ."\n" .'- **MARKETING**: marketing template.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request is successful.'."\n" ."\n" .'- For other error codes, see [Error codes](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Validate whatsApp direct-send template content', 'summary' => 'Validates the content of a WhatsApp direct-send template.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:CheckDirectSendMessageSample', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Message\\": \\"example\\",\\n \\"Data\\": {\\n \\"Category\\": \\"example\\",\\n \\"Success\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CopyTemplate' => [ 'summary' => 'Copies a 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' => 'SceneTemplateCode', 'in' => 'query', 'schema' => ['description' => 'The template code.', 'type' => 'string', 'required' => true, 'example' => '12456', 'title' => ''], ], [ 'name' => 'SceneTemplateName', 'in' => 'query', 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => '示例值', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'SceneTemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'WhatsappCatagory' => ['description' => 'The WhatsApp category.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'SceneTemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Copy template', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CopyTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'CreateChatFlow' => [ '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' => 'The title of the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'WhatsApp自动回复'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '通过API触发下发验证模板'], ], [ 'name' => 'FlowTriggerType', 'in' => 'query', 'schema' => [ 'description' => 'The trigger type for the flow. Valid values:'."\n" ."\n" .'- TriggeredManually'."\n" ."\n" .'- TriggeredByWhatsApp'."\n" ."\n" .'- TriggeredByMessenger'."\n" ."\n" .'- TriggeredByInstagram'."\n" ."\n" .'- TriggeredByViber', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['TriggeredManually' => 'TriggeredManually', 'TriggeredByWhatsApp' => 'TriggeredByWhatsApp', 'TriggeredByMessenger' => 'TriggeredByMessenger', 'TriggeredByInstagram' => 'TriggeredByInstagram', 'TriggeredByViber' => 'TriggeredByViber'], 'title' => '', 'example' => 'TriggeredByWhatsApp', ], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'Business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Data' => ['description' => 'The returned data object.', 'type' => 'object', 'example' => '', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Create Chatflow', 'summary' => 'Creates a flow.', 'description' => '- This API operation creates a flow. You can also create a flow manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) interface.'."\n" ."\n" .'- After you create a flow, you can orchestrate the canvas. For more information, see [Flow Editor components](~~2836818~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'CreateChatFlowByImport' => [ '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' => 'The title of the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'WhatsApp触发订阅'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '触发订阅'], ], [ 'name' => 'FlowViewModel', 'in' => 'query', 'schema' => ['description' => 'The flow DSL data to import. This is a block of data in JSON format. To obtain this data, arrange the components on the canvas in the Flow Editor, save the flow, and then click **Settings** > **Export** in the upper-right corner of the canvas. The flow is exported as a JSON data file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" .' "schema": {'."\n" .' "namespace": "External",'."\n" .' "version": "1.0",'."\n" .' "copyright": "Alibaba Cloud"'."\n" .' },'."\n" .' "editor": "H4sIAAAAAAAAA+1YbU/c***********************",'."\n" .' "flow": {'."\n" .' "triggerType": "TriggeredByWhatsApp"'."\n" .' }'."\n" .'}'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Data' => ['description' => 'The returned data object.', 'type' => 'object', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Import and Create ChatFlow', 'summary' => 'Creates and imports a flow.', 'description' => '- You can call this operation to create and import a flow. You can also create and import a flow manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before you call this operation, ensure that you have exported the Domain-Specific Language (DSL) data for the flow.'."\n" ."\n" .'- If you do not have the exported DSL data for a flow, go to the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder). Click a flow name to open the canvas. Arrange the components on the canvas, save the flow, and then export it as a JSON data file.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlowByImport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'CreateChatFlowLogSetting' => [ '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' => 'The code of the flow. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the denied access.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Create Process Log Setting', 'summary' => 'Creates log settings for a flow.', 'description' => '- To update the log settings for a flow using the API, you must first create the log settings. After the settings are created, call the [ReadChatFlowLogSetting](~~2937212~~) operation to view the log settings. Then, call the [UpdateChatFlowLogSetting](~~2937210~~) operation to update the settings.'."\n" ."\n" .'- If you do not need to update the log settings using the API, you can manually update the log settings on the Log page. In the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder), choose **Settings** > **Log**.'."\n" ."\n" .'- Before you call this operation, make sure that you have successfully created a flow.'."\n" ."\n" .'- If you do not have a successfully created flow, you can create one manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) or by calling the [CreateChatFlow](~~2937204~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'CreateChatappMigrationInitiate' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162637', 'abilityTreeNodes' => ['FEATUREcamsGUB2IL'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the Independent Software Vendor (ISV) sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849493****', 'title' => ''], ], [ 'name' => 'MobileNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. Do not include the country code.', 'type' => 'string', 'required' => true, 'example' => '1390000****', 'title' => ''], ], [ 'name' => 'CountryCode', 'in' => 'query', 'schema' => ['description' => 'The country code.', 'type' => 'string', 'required' => true, 'example' => '86', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the phone number.'."\n" .'Valid value: MIGRATING: The phone number is being migrated.', 'type' => 'string', 'example' => 'MIGRATING', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861390000****', 'title' => ''], 'Id' => ['description' => 'The ID of the phone number.', 'type' => 'string', 'example' => '8282889****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'CreateChatappMigrationInitiate', 'summary' => 'Initiates the migration of a phone number.', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:15.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:47.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatappMigrationInitiate'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatappMigrationInitiate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'CreateChatappTemplate' => [ 'summary' => 'Creates a message template. After a template is approved, you can use it to send messages.', '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' => ['description' => 'WhatsApp template categories:'."\n" ."\n" .'- **UTILITY**: Transactional.'."\n" ."\n" .'- **MARKETING**: Marketing.'."\n" ."\n" .'- **AUTHENTICATION**: Authentication.'."\n" ."\n" .'Viber template categories:'."\n" ."\n" .'- **UTILITY**: Transactional.'."\n" ."\n" .'- **MARKETING**: Marketing.'."\n" ."\n" .'- **AUTHENTICATION**: Authentication.', 'type' => 'string', 'required' => true, 'example' => 'UTILITY', 'title' => ''], ], [ 'name' => 'Components', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of message template components.'."\n" ."\n" .'> When Category is set to AUTHENTICATION, the Components array cannot contain a component of the HEADER type. If the component type is BODY or FOOTER, the Text parameter must be empty.', 'type' => 'array', 'items' => [ 'description' => 'The list of components.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The component type. Valid values:'."\n" ."\n" .'- **BODY**'."\n" ."\n" .'- **HEADER**'."\n" ."\n" .'- **FOOTER**'."\n" ."\n" .'- **BUTTONS**'."\n" ."\n" .'- **CAROUSEL**'."\n" ."\n" .'- **LIMITED\\_TIME\\_OFFER**'."\n" ."\n" .'> * For WhatsApp templates, the BODY component can contain up to 1,024 characters. The HEADER and FOOTER components can contain up to 60 characters.'."\n" .'>'."\n" .'> * For Viber templates, the FOOTER, CAROUSEL, and LIMITED\\_TIME\\_OFFER types are invalid.'."\n" .'>'."\n" .'> * For Viber templates, images, videos, and files are placed in the HEADER component. The client displays the image below the text. The text is placed in the BODY component.', 'type' => 'string', 'required' => true, 'example' => 'BODY', 'title' => ''], 'Text' => ['description' => 'The text of the message to send.'."\n" ."\n" .'> For WhatsApp templates, if Category is set to AUTHENTICATION, this parameter is empty.', 'type' => 'string', 'example' => 'hello whatsapp', 'title' => '', 'required' => false], 'Format' => ['description' => 'The type of the media resource.'."\n" ."\n" .'- **TEXT**: text'."\n" ."\n" .'- **IMAGE**: image'."\n" ."\n" .'- **DOCUMENT**: document'."\n" ."\n" .'- **VIDEO**: video', 'type' => 'string', 'example' => 'TEXT', 'title' => '', 'required' => false], 'Url' => ['description' => 'The path of the media resource.'."\n" ."\n" .'> For Viber templates, the recommended image size is 800 × 800 pixels.', 'type' => 'string', 'example' => 'https://image.developer.aliyundoc.com', 'title' => '', 'required' => false], 'Caption' => ['description' => 'The description of the file.', 'type' => 'string', 'example' => 'This is a video', 'title' => '', 'required' => false], 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'Express delivery video', 'title' => '', 'required' => false], 'Buttons' => [ 'title' => '', 'description' => 'The list of buttons. This parameter applies only to the **BUTTONS** component.'."\n" ."\n" .'> Number of buttons for WhatsApp'."\n" .'>'."\n" .'> - For MARKETING or UTILITY templates, you can add up to 10 buttons.'."\n" .'>'."\n" .'> - You can add only one button of the PHONE\\_NUMBER type.'."\n" .'>'."\n" .'> - You can add up to two buttons of the URL type.'."\n" .'>'."\n" .'> - Buttons of the QUICK\\_REPLY type cannot be mixed with buttons of the PHONE\\_NUMBER or URL type.'."\n" ."\n" .'> Number of buttons for Viber'."\n" .'>'."\n" .'> - Only one button of the URL type is allowed.'."\n" .'>'."\n" .'> - If the HEADER component contains a video, the button type is URL, but you cannot set a URL.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The button definition.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The button type.'."\n" ."\n" .'- **PHONE\\_NUMBER**: A call button.'."\n" ."\n" .'- **URL**: A URL button.'."\n" ."\n" .'- **QUICK\\_REPLY**: A quick reply button.'."\n" ."\n" .'- **COPY\\_CODE**: A button to copy a verification code or coupon code.'."\n" ."\n" .'- **ONE\\_TAP**: An autofill button for AUTHENTICATION templates.'."\n" ."\n" .'- **ZERO\\_TAP**: An autofill button for AUTHENTICATION templates.'."\n" ."\n" .'- **MPM**: A multi-product message.'."\n" ."\n" .'- **CATALOG**: A catalog.'."\n" ."\n" .'- **FLOW**: Opens a WhatsApp flow.'."\n" ."\n" .'> * For WhatsApp templates, if Category is set to AUTHENTICATION, only one button is allowed. The button type must be COPY\\_CODE or ONE\\_TAP. If you set the button type to COPY\\_CODE, the Text parameter is required. If you set the button type to ONE\\_TAP, the Text (the name of the copy code button displayed on the client if the destination app is not installed), SignatureHash, PackageName, and AutofillText parameters are required.'."\n" .'>'."\n" .'> * For Viber templates, only one button is allowed, and it must be of the URL type.', 'type' => 'string', 'required' => true, 'example' => 'PHONE_NUMBER', 'title' => ''], 'Text' => ['description' => 'The name displayed on the button.', 'type' => 'string', 'example' => 'Call Me', 'title' => '', 'required' => false], 'PhoneNumber' => ['description' => 'The phone number. This parameter is valid only when the button type is **PHONE\\_NUMBER**.', 'type' => 'string', 'example' => '+861368897****', 'title' => '', 'required' => false], 'Url' => ['description' => 'The URL that is visited when the URL button is clicked.', 'type' => 'string', 'example' => 'https://example.com', 'title' => '', 'required' => false], 'UrlType' => ['description' => 'The URL type.'."\n" ."\n" .'- **static**: Static'."\n" ."\n" .'- **dynamic**: Dynamic', 'type' => 'string', 'example' => 'static', 'title' => '', 'required' => false], 'SignatureHash' => ['description' => 'Use the properties under SupportedApps.', 'type' => 'string', 'deprecated' => true, 'example' => 'wi299382', 'title' => '', 'required' => false], 'PackageName' => ['description' => 'Use the properties under SupportedApps.', 'type' => 'string', 'deprecated' => true, 'example' => 'com.demo', 'title' => '', 'required' => false], 'AutofillText' => ['description' => 'This parameter is required for WhatsApp templates when Category is set to AUTHENTICATION and the button type is ONE\\_TAP or ZERO\\_TAP. It specifies the button text for the WhatsApp autofill action.', 'type' => 'string', 'example' => 'Autofill', 'title' => '', 'required' => false], 'IsOptOut' => ['description' => 'This parameter is valid for WhatsApp templates when Category is set to Marketing and the button type is QUICK\\_REPLY. It indicates that the button is a marketing opt-out button. If a customer clicks this button and you have configured sending control operations in ChatApp, subsequent marketing messages will not be sent to the customer.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], 'CouponCode' => ['description' => 'The value of the coupon code. It supports only letters and digits. You can pass a variable such as $(couponCode) and then pass the actual coupon code when sending the message.', 'type' => 'string', 'example' => '120293', 'title' => '', 'required' => false], 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '479884093605****', 'title' => '', 'required' => false], 'FlowAction' => [ 'description' => 'The flow data event type. Valid values:'."\n" ."\n" .'- DATA\\_EXCHANGE: Data exchange.'."\n" ."\n" .'- NAVIGATE: Navigation.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'NAVIGATE', 'title' => '', 'required' => false, ], 'NavigateScreen' => ['description' => 'The screen to navigate to. This parameter is required when FlowAction is set to NAVIGATE.', 'type' => 'string', 'example' => 'DETAILS', 'title' => '', 'required' => false], 'SupportedApps' => [ 'title' => '', 'description' => 'The list of supported apps.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SignatureHash' => ['description' => 'This parameter is required for WhatsApp templates when Category is set to AUTHENTICATION and the button type is ONE\\_TAP or ZERO\\_TAP. It specifies the signature hash of the app that WhatsApp will launch.', 'type' => 'string', 'example' => 'ieid83kdiek', 'title' => '', 'required' => false], 'PackageName' => ['description' => 'This parameter is required for WhatsApp templates when Category is set to AUTHENTICATION and the button type is ONE\\_TAP or ZERO\\_TAP. It specifies the package name of the app that WhatsApp will launch.', 'type' => 'string', 'example' => 'com.kuaidian.waimaistaff', 'title' => '', 'required' => false], ], 'required' => false, 'description' => '', 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 5, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'ThumbUrl' => ['description' => 'The thumbnail of a Viber message that contains a video.', 'type' => 'string', 'example' => 'https://cdn.multiplymall.mobiapp.cloud/yunmall/B-LM-LMALL202207130001/20220730/d712a057-a6af-4513-bbe6-7ee57ea60983.png?x-oss-process=image/resize,w_100', 'title' => '', 'required' => false], 'Duration' => ['description' => 'The duration of the video in a Viber video message, in seconds. The value ranges from 0 to 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => '', 'required' => false], 'FileType' => ['description' => 'The file type of a Viber file message.', 'type' => 'string', 'example' => 'docx', 'title' => '', 'required' => false], 'CodeExpirationMinutes' => ['description' => 'The validity period of the verification code for a WhatsApp AUTHENTICATION template, in minutes. This parameter is valid only for WhatsApp messages when Category is set to AUTHENTICATION and the component type is Footer. This information is displayed in the footer.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '90', 'minimum' => '1', 'example' => '5', 'title' => '', 'required' => false], 'AddSecretRecommendation' => ['description' => 'This parameter is valid for WhatsApp templates when Category is set to AUTHENTICATION and the component type is Body. It indicates that a security recommendation is displayed above the body, advising the user not to share the verification code.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], 'HasExpiration' => ['description' => 'Indicates whether the coupon code has an expiration time. This parameter is used when type is set to LIMITED\\_TIME\\_OFFER.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => 'true'], 'Cards' => [ 'description' => 'The list of cards for a carousel template.', 'type' => 'array', 'items' => [ 'description' => 'The card object for a carousel template.', 'type' => 'object', 'properties' => [ 'CardComponents' => [ 'title' => '', 'description' => 'The list of controls in the carousel card.', 'type' => 'array', 'items' => [ 'description' => 'The card object in the carousel template.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The component type. Valid values:'."\n" ."\n" .'- **BODY**'."\n" ."\n" .'- **HEADER**'."\n" ."\n" .'- **BUTTONS**', 'type' => 'string', 'required' => true, 'example' => 'BODY', 'title' => ''], 'Format' => ['description' => 'The type of the media resource. This parameter is valid when Type is set to HEADER.'."\n" ."\n" .'- **IMAGE**: image'."\n" ."\n" .'- **VIDEO**: video', 'type' => 'string', 'example' => 'IMAGE', 'title' => '', 'required' => false], 'Text' => ['description' => 'The content of the BODY component in the carousel card.', 'type' => 'string', 'example' => 'Who is the very powerful team', 'title' => '', 'required' => false], 'Url' => ['description' => 'The path of the media resource.', 'type' => 'string', 'example' => 'https://alibaba.com/img.png', 'title' => '', 'required' => false], 'Buttons' => [ 'title' => '', 'description' => 'The list of buttons. This parameter applies only to the BUTTONS component. Each card in a carousel can have a maximum of two buttons.', 'type' => 'array', 'items' => [ 'description' => 'The button object.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The button text.', 'type' => 'string', 'required' => false, 'example' => 'Call me', 'title' => ''], 'Type' => ['description' => 'The button type.'."\n" ."\n" .'- **PHONE\\_NUMBER**: A call button.'."\n" ."\n" .'- **URL**: A URL button.'."\n" ."\n" .'- **QUICK\\_REPLY**: A quick reply button.', 'type' => 'string', 'required' => true, 'example' => 'PHONE_NUMBER', 'title' => ''], 'Url' => ['description' => 'The URL that is visited when the button is clicked.', 'type' => 'string', 'example' => 'https://alibaba.com/xx', 'title' => '', 'required' => false], 'UrlType' => ['description' => 'The URL type.'."\n" ."\n" .'- **static**: Static'."\n" ."\n" .'- **dynamic**: Dynamic', 'type' => 'string', 'example' => 'static', 'title' => '', 'required' => false], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '+86138007****', 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'maxItems' => 10, 'minItems' => 1, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Name', 'in' => 'formData', 'schema' => ['description' => 'The template name.', 'type' => 'string', 'required' => true, 'example' => 'hello_whatsapp', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'formData', 'schema' => ['description' => 'The template language. For more information about language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'en', 'title' => ''], ], [ 'name' => 'Example', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'An example of how to create a template.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'An example of how to create a template.', 'type' => 'string', 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], 'enumValueTitles' => [], 'example' => 'hello_whatsapp', ], ], [ 'name' => 'TemplateType', 'in' => 'formData', 'schema' => ['description' => 'The template type.'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'- **VIBER**', 'type' => 'string', 'required' => true, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'CustWabaId', 'in' => 'formData', 'schema' => ['description' => 'The WhatsApp Business Account (WABA) ID of the independent software vendor (ISV) customer.'."\n" ."\n" .'> This parameter is deprecated. Use CustSpaceId instead.', 'type' => 'string', 'deprecated' => true, 'example' => '65921621816****', 'title' => '', 'required' => false], ], [ 'name' => 'IsvCode', 'in' => 'formData', 'schema' => ['description' => 'The ISV verification code, used to verify whether the RAM user is authorized by the ISV.', 'type' => 'string', 'example' => 'skdi3kksloslikdkkdk', 'title' => '', 'required' => false], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The Space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'docRequired' => true, 'example' => '293483938849493', 'title' => '', 'required' => true], ], [ 'name' => 'AllowCategoryChange', 'in' => 'formData', 'schema' => ['description' => 'Indicates whether to allow Facebook to automatically change the category of the template. This can increase the approval rate of the template. This parameter is valid only when TemplateType is set to WHATSAPP.'."\n" .'>This property is deprecated. WhatsApp no longer supports this property.>', 'type' => 'boolean', 'deprecated' => true, 'required' => false, 'title' => '', 'example' => 'true'], ], [ 'name' => 'MessageSendTtlSeconds', 'in' => 'formData', 'schema' => ['description' => 'The time-to-live (TTL) of the template message in WhatsApp.'."\n" ."\n" .'- For AUTHENTICATION templates, the value ranges from 30 to 900.'."\n" ."\n" .'- For UTILITY templates, the value ranges from 30 to 43200.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2592000', 'minimum' => '30', 'example' => '120', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D'], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- An \\`OK\\` response indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [API error codes](https://www.alibabacloud.com/help/en/cams/latest/api-error-codes).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'User not authorized to operate on the specified resource.'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'title' => '', 'example' => 'SMS_232907****'], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'title' => '', 'example' => 'hello_whatsapp'], ], 'example' => '{"templateCode": "****4b5c79c9432497a075bdfca36bf5"，"templateName": "hello_whatsapp"}', 'title' => '', ], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'title' => 'CreateChatappTemplate', 'description' => '### QPS limit'."\n" ."\n" .'The queries per second (QPS) limit for this API operation is 50 for a single user. If you exceed the limit, API calls are rate-limited, which may affect your business. We recommend that you call this operation at a reasonable frequency.'."\n" ."\n" .'### Status change'."\n" ."\n" .'You can monitor template status and quality changes using Message Service (MNS) or HTTP. For more information, see [Message receipts](~~421545~~).', 'changeSet' => [ ['createdAt' => '2025-06-11T13:05:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-04-22T10:09:16.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-26T05:51:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-02T02:33:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-21T01:24:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:58:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-19T06:41:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-17T12:01:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T11:29:48.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-08T11:38:22.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-13T11:48:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T12:02:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-06-21T09:19:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-08T12:37:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatappTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'CreateCustomAudience' => [ 'summary' => 'Creates a custom audience.', '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' => 'The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the'."\n" ."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-***', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'required' => true, 'example' => '239***', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'required' => true, 'example' => '23**', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The name of the custom audience.', 'type' => 'string', 'required' => true, 'example' => 'audience name', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], ], [ 'name' => 'UploadType', 'in' => 'query', 'schema' => [ 'description' => 'The upload method.', 'enumValueTitles' => ['excel' => '', 'intf' => ''], 'type' => 'string', 'required' => true, 'example' => 'excel', 'title' => '', ], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The file path.', 'type' => 'string', 'required' => false, 'example' => 'bucket/file.xlsx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'CustomAudienceId' => ['description' => 'The ID of the custom audience.', 'type' => 'string', 'example' => '393**', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'dd**', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateCustomAudience', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateCustomAudience', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"CustomAudienceId\\": \\"393**\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"dd**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CreateFlow' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '200947', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'FlowName', 'in' => 'query', 'schema' => ['description' => 'The name of the Flow.', 'type' => 'string', 'required' => true, 'example' => 'flow-001', 'title' => ''], ], [ 'name' => 'Categories', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The categories.', 'type' => 'array', 'items' => [ 'description' => 'The category information.', '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'], 'type' => 'string', 'required' => false, 'example' => 'SIGN_UP', 'title' => '', ], 'required' => true, 'example' => '', 'title' => '', ], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-alk21lk3j2k3lj', 'title' => ''], ], [ 'name' => 'EndpointUri', 'in' => 'query', 'schema' => ['description' => 'The URL of the WA Flow Endpoint', 'type' => 'string', 'required' => false, 'example' => 'http://www.***.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'Flow ID。', 'type' => 'string', 'example' => '333993838***', 'title' => ''], 'Categories' => [ 'description' => 'The list of categories.', 'type' => 'array', 'items' => ['description' => 'The Flow category information.', 'type' => 'string', 'example' => 'SIGN_UP', 'title' => ''], 'example' => '', 'title' => '', ], 'FlowName' => ['description' => 'The name of the Flow.', 'type' => 'string', 'example' => 'test1', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response code. OK indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Create a flow', 'summary' => 'Creates a Flow.', 'description' => 'The China Message Service (Chinese SMS) API has a single-user QPS limit of 5 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], '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' => 'The code of the flow. You can view the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'FlowVersionCopyFrom', 'in' => 'query', 'schema' => ['description' => 'The version of the flow to copy. To view the historical versions of a flow, go to the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) and click a flow name to open the orchestration canvas.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '修复发送WhatsApp消息错误'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The status code of the request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Create Flow Version', 'summary' => 'Creates a new version of a flow by copying an existing version.', 'description' => '- You can call this operation to create a new flow version. You can also manually copy a flow version from the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder). To do this, click a flow name to open the orchestration canvas and then copy the version.'."\n" ."\n" .'- Before you call this operation, make sure that you have created a flow.'."\n" ."\n" .'- If you have not created a flow, you can create one manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) or by calling the [CreateChatFlow](~~2937204~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'CreateInstance' => [ 'summary' => 'Creates an instance.', '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' => 'The channel type.', 'type' => 'string', 'required' => true, 'example' => 'VIBER', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'viber_ins', 'title' => ''], ], [ 'name' => 'InstanceDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ins', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group that contains the instance.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'OfficeAddress', 'in' => 'query', 'schema' => ['description' => 'The office address of the business.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'ContactMail', 'in' => 'query', 'schema' => ['description' => 'The contact email address.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'CountryId', 'in' => 'query', 'schema' => ['description' => 'The country code.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FacebookBmId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Facebook Business Manager (BM).', 'type' => 'string', 'required' => false, 'example' => '393992929', 'title' => ''], ], [ 'name' => 'IsvTerms', 'in' => 'query', 'schema' => ['description' => 'The URL of the ISV terms file.', 'type' => 'string', 'required' => false, 'example' => 'https://a.com/1.pdf', 'title' => ''], ], [ 'name' => 'IsConfirmAudit', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to confirm the audit.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '2992939*****', 'title' => ''], 'Message' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => 'ins', 'title' => ''], 'ResourceRegionId' => ['description' => 'The ID of the region where the resource is located.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '2999292', 'title' => ''], 'InstanceDescription' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'des', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the request was submitted.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'ChannelType' => ['description' => 'The channel type.', 'type' => 'string', 'example' => 'example', 'title' => ''], ], 'example' => '', 'description' => 'The returned data object.', 'title' => '', ], 'Code' => ['description' => 'The response code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success and `false` indicates failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'CreateInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2992939*****\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Data\\": {\\n \\"InstanceName\\": 0,\\n \\"ResourceRegionId\\": \\"example\\",\\n \\"InstanceId\\": \\"2999292\\",\\n \\"InstanceDescription\\": \\"des\\",\\n \\"SubmitTime\\": \\"example\\",\\n \\"ChannelType\\": \\"example\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'CreateMessageCampaign' => [ 'summary' => 'Creates a budget.', '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' => 'The space ID of an Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-x***', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Messenger Page ID.', 'type' => 'string', 'required' => true, 'example' => '238***', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'required' => true, 'example' => '3993**', 'title' => ''], ], [ 'name' => 'BudgetType', 'in' => 'query', 'schema' => [ 'description' => 'The budget type.', 'enumValueTitles' => ['daily' => '', 'lifetime' => ''], 'type' => 'string', 'required' => true, 'example' => 'daily', 'title' => '', ], ], [ 'name' => 'Budget', 'in' => 'query', 'schema' => ['description' => 'The budget, in cents.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '300', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', 'schema' => ['description' => 'The budget name.', 'type' => 'string', 'required' => true, 'example' => 'Example', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'CampaignId' => ['description' => 'The campaign ID.', 'type' => 'string', 'example' => '39***', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateMessageCampaign', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"Example\\",\\n \\"RequestId\\": \\"Example\\",\\n \\"CampaignId\\": \\"39***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CreateMessengerPage' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值示例值'], ], [ 'name' => 'AuthenticationCode', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值'], ], [ 'name' => 'AdAccountIds', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'required' => true], 'required' => true, 'example' => '', ], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值'], ], [ 'name' => 'BusinessId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string'], 'RequestId' => ['type' => 'string', 'example' => '示例值示例值'], 'Message' => ['type' => 'string', 'example' => '示例值示例值'], 'Code' => ['type' => 'string', 'example' => '示例值示例值'], 'Success' => ['type' => 'boolean', 'example' => 'true'], ], ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'CreatePhoneMessageQrdl' => [ 'summary' => 'Creates a message QR code.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '200908', 'abilityTreeNodes' => ['FEATUREcamsU2M7I2'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. You can view the phone number on the'."\n" .'[**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)> **Manage** > **WABA Management** > **Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86138009****'."\n", 'title' => ''], ], [ 'name' => 'GenerateQrImage', 'in' => 'query', 'schema' => ['description' => 'The type of the generated image. Valid values:'."\n" ."\n" .'- PNG'."\n" ."\n" .' - SVG', 'type' => 'string', 'required' => true, 'example' => 'PNG', 'title' => ''], ], [ 'name' => 'PrefilledMessage', 'in' => 'query', 'schema' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'test', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)'."\n" .'page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'QrImageUrl' => ['description' => 'The URL of the QR code image.', 'type' => 'string', 'example' => 'http://img.png', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '86138009****', 'title' => ''], 'QrdlCode' => ['description' => 'The QR code identifier.', 'type' => 'string', 'example' => 'D9II3***', 'title' => ''], 'DeepLinkUrl' => ['description' => 'The deep link URL.', 'type' => 'string', 'example' => 'https://wa.qrdl/', 'title' => ''], 'GenerateQrImage' => ['description' => 'The type of the generated image.', 'type' => 'string', 'example' => 'PNG', 'title' => ''], 'PrefilledMessage' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Create a message QR code', 'description' => '- After the QR code is created, users can scan it with WhatsApp to quickly open the corresponding business phone number.'."\n" ."\n" .'- Before calling this operation, make sure that you have a successfully created WhatsApp message channel.'."\n" ."\n" .'- If you do not have a successfully created WhatsApp message channel, manually create one on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)'."\n" .'page.'."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:55.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePhoneMessageQrdl'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreatePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'CreateWhatsappConversionApi' => [ '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' => ['type' => 'string', 'required' => false, 'example' => '131', 'description' => '', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'code', 'description' => '', 'title' => ''], ], [ 'name' => 'Permissions', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'User', 'title' => ''], 'required' => false, 'example' => '', 'description' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '无', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeleteChatFlow' => [ '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' => 'The flow code. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The extended business information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Delete Process', 'summary' => 'Deletes a flow.', 'description' => '- You can call this operation to delete a flow. You can also manually delete a flow in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before you delete a flow, make sure its status is Unpublished.'."\n" ."\n" .'- Deleted flows cannot be recovered. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], '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' => 'The business phone number.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> Only the WhatsApp channel type is supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID.', 'type' => 'string', 'required' => true, 'example' => 'E399**', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer, which is the channel ID. You can view it on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The response code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Result' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete an IM group', 'summary' => 'Deletes a successfully created IM group.', 'description' => '>The API-based IM group deletion feature is a Meta beta feature. Contact your account manager to apply for access.>'."\n" ."\n" .'- Before calling this operation, make sure that you have a successfully created IM group.'."\n" ."\n" .'- If you do not have a successfully created IM group, call the [AddChatGroup](~~2998429~~) operation to create one.'."\n" ."\n" .'- A deleted IM group cannot be recovered. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], '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' => 'The business phone number. You can view the business phone number by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> Only WhatsApp channel type messages are supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID. You can view the group ID by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'E398****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-8***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The response code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Result' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete an IM group invitation link', 'summary' => 'Deletes an IM group invitation link.', 'description' => '>The ability to delete IM group invitation links through the API is a Meta beta feature. Contact your account manager to request access.>'."\n" ."\n" .'- Before calling this operation, make sure that the IM group you created already has an IM group invitation link added.'."\n" ."\n" .'- If you do not have an existing IM group, call the [AddChatGroup](~~2998429~~) and [AddChatGroupInviteLink](~~3019211~~) operations to create an IM group and add an invitation link.'."\n" ."\n" .'- After you delete an IM group invitation link, the IM group can no longer invite members to join. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroupInviteLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => 'Removes members from an IM group.', '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' => 'The business number. You can obtain the business number by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => '8613800**', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid value:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> Currently, only the WhatsApp channel is supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP'."\n", 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID. You can obtain the group ID by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'EA93UU****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID. This ID is also the channel ID. You can find the channel ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'List', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of group members to remove.', 'type' => 'array', 'items' => [ 'description' => 'Information about a group member.', 'type' => 'object', 'properties' => [ 'ParticipantNumber' => ['description' => 'The participant number of the group member. You can obtain the participant numbers of group members by calling the [ListChatGroupParticipants](~~2932628~~) operation.', 'type' => 'string', 'required' => false, 'example' => '86138***', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The status code. Valid values:'."\n" ."\n" .'- OK: The request is successful.'."\n" ."\n" .'- For other error codes, see the [error code list](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Result' => ['description' => 'The number of rows affected.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": 20\\n}","type":"json"}]', 'title' => 'DeleteChatGroupParticipants', 'description' => '>'."\n" ."\n" .'This operation is a beta feature from Meta. Contact your account manager to add your account to the allowlist before use.'."\n" ."\n" .'>'."\n" ."\n" .'- This operation requires an existing IM group that members have joined via an invitation link.'."\n" ."\n" .'- To create an IM group and add an invitation link, call the [AddChatGroup](~~2998429~~) and [AddChatGroupInviteLink](~~3019211~~) operations.'."\n" ."\n" .'- Removed members no longer receive messages from the group. Use this operation with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroupParticipants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], '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 code of the template.', 'type' => 'string', 'required' => false, 'example' => '744c4b5c79c9432497a075bdfca3****', 'title' => ''], ], [ 'name' => 'CustWabaId', 'in' => 'query', 'schema' => ['description' => 'The WhatsApp Business Account (WABA) ID of the Independent Software Vendor (ISV) customer.'."\n" ."\n" .'> This parameter is deprecated. Use CustSpaceId instead.', 'type' => 'string', 'required' => false, 'example' => '65921621816****', 'title' => ''], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'The ISV verification code, which is used to verify whether the user is authorized by the ISV.', 'type' => 'string', 'required' => false, 'example' => 'skdi3kksloslikdkkdk', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '28251486512358****', 'title' => ''], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['description' => 'The name of the template.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => false, 'example' => 'zh_CN', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['description' => 'The type of the template. This parameter is required when you delete a template for a specific language.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful:'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeleteChatappTemplate', 'description' => '### QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-03-26T05:51:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T11:29:52.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-08T12:37:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteChatappTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'DeleteContacts' => [ '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' => ['type' => 'string', 'required' => false, 'example' => 'http://****', 'description' => '', 'title' => ''], ], [ 'name' => 'ContactDetails', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '1507486****', 'description' => '', 'title' => ''], ], [ 'name' => 'ContactName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'hahaha', 'description' => '', 'title' => ''], ], [ 'name' => 'Country', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'China', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '11111', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => 'true', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteContacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"11111\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeleteContactsByIds' => [ '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' => 'The list of contact codes, separated by commas (,).', 'type' => 'string', 'required' => true, 'example' => '示例值示例值示例值', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => 'True', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Batch delete contacts', 'summary' => 'Deletes contacts by selecting and removing them.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteContactsByIds', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DeleteFlow' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201009', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The workflow ID.', 'type' => 'string', 'required' => true, 'example' => '346699123', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-awlkj23a09jd', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details of the permission verification failure.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Code' => ['description' => 'The result. OK indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Delete a flow', 'summary' => 'Deletes a Flow (only Flows in DRAFT status can be deleted).', 'description' => 'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-26T03:25:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeleteFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"无\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'DeleteFlowVersion' => [ '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' => 'The flow code. You can view the flow code in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'example' => '9ccc41**************************', 'title' => ''], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. Click a flow name in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) to go to the canvas page and view the flow version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'ALICOM_OPAAS', 'default' => 'ALICOM_OPAAS', 'title' => '', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: an empty collection.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response content.', 'type' => 'object', 'example' => '434991', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a flow version', 'summary' => 'Deletes a flow version.', 'description' => '- You can call this operation to delete a flow version, or click a flow name in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) to go to the canvas orchestration page and manually delete the flow version.'."\n" ."\n" .'- Before calling this operation, make sure that the flow version is in the offline state and that at least two flow versions exist.'."\n" ."\n" .'- If the flow version is in the online state, click the flow name in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) to go to the canvas orchestration page and manually take the flow version offline, or call the [OfflineFlowVersion](~~2937198~~) operation to take the flow version offline.'."\n" ."\n" .'- After a flow version is deleted, the canvas flow that you orchestrated cannot be recovered. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], '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' => ['type' => 'string', 'required' => true, 'example' => '112', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '1223-1111', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteGroupById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"1223-1111\\",\\n \\"Data\\": \\"示例值示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeleteInstagramPage' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '154654654654654', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'ok', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'gfdg435t-hf544**', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => 'true', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"gfdg435t-hf544**\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeleteInstance' => [ 'summary' => 'Deletes the specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '205980', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '2399393****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'RequestId' => ['description' => 'The unique ID for the request. Use it for troubleshooting.', 'type' => 'string', 'example' => '3993939******', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of `OK` means the request was successful.'."\n" ."\n" .'- For other error codes, see the [Error Code List](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Specifies whether the request was successful. Valid values:'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"3993939******\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'DeleteMarketingFlow' => [ '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' => 'The activity code. You can use the system-generated code or modify it to use a custom code.', 'type' => 'string', 'required' => false, 'example' => '1111', 'title' => ''], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => ['description' => 'The activity ID (deprecated).', 'type' => 'string', 'required' => false, 'example' => '已弃用', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Data' => ['description' => 'The returned data object.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a marketing campaign', 'summary' => 'Deletes a marketing campaign.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'DeleteMessageCampaign' => [ 'summary' => 'Deletes the budget for a marketing campaign.', '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' => 'The space ID of an Independent Software Vendor (ISV) sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-x**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID of Messenger.', 'type' => 'string', 'required' => true, 'example' => '293***', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'required' => true, 'example' => '293**', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The campaign ID.', 'type' => 'string', 'required' => true, 'example' => '329**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '239***', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteMessageCampaign', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"239***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteMessengerPage' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '154332432432', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'e01-in-71cc15xxx', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'JHGJG-65HFGF**', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => 'true', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"JHGJG-65HFGF**\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'DeletePhoneMessageQrdl' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '200942', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. You can view the phone number on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) > **Management** > **WABA Management** > **Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86158********'."\n", 'title' => ''], ], [ 'name' => 'QrdlCode', 'in' => 'query', 'schema' => ['description' => 'The QR code encoding. This is the QrdlCode returned by the [CreatePhoneMessageQrdl](~~2638749~~) operation when you created the message QR code, or the QrdlCode returned by the [UpdatePhoneMessageQrdl](~~2638746~~) operation when you updated the QR code.', 'type' => 'string', 'required' => true, 'example' => 'D9II3***'."\n", 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Delete a message QR code', 'summary' => 'Deletes a message QR code.', 'description' => '- After you delete a message QR code, users can no longer open the corresponding business phone number by scanning the original QR code. Proceed with caution.'."\n" ."\n" .'- Before calling this operation, make sure that you have a successfully created message QR code.'."\n" ."\n" .'- If you do not have a successfully created message QR code, call the [CreatePhoneMessageQrdl](~~2638749~~) operation to create one first.'."\n" ."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as appropriate.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:55.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePhoneMessageQrdl'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeletePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'DeprecateFlow' => [ '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' => 'formData', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '1212323', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-awsd12312o3j', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => '', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The reason why access was denied.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'DeprecateFlow', 'summary' => 'Deprecates a WhatsApp flow.', 'description' => 'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled and may result in service interruptions.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprecateFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeprecateFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'EnableWhatsappROIMetric' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195264', 'abilityTreeNodes' => ['FEATUREcamsX2FDGF'], ], 'parameters' => [ [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'The ISV verification code, which is used to verify that the RAM user is authorized by the ISV.', 'type' => 'string', 'required' => false, 'example' => 'skdi3kksloslikd****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-************'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [API error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Enable whatsApp ROI metric collection', 'summary' => 'Enables WhatsApp-related metric collection.', 'description' => '- Before you retrieve metrics for the message sending volume of WhatsApp-type channels or metrics related to Marketing-type templates by calling API operations, call this operation to enable WhatsApp ROI metric collection.'."\n" ."\n" .'- After you enable WhatsApp ROI metric collection, at least one day is required before metric data becomes available. Message sending volume metrics and Marketing-type template metrics for messages sent before the feature is enabled are not collected.'."\n" ."\n" .'- After you enable WhatsApp ROI metric collection, you can call the [GetChatappPhoneNumberMetric](~~2557788~~) operation to query the sending volume metrics of a phone number, or call the [GetChatappTemplateMetric](~~2557790~~) operation to query metrics related to Marketing-type templates.'."\n" .'### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:50.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableWhatsappROIMetric'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:EnableWhatsappROIMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'FlowBindPhone' => [ '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' => 'The flow code. View the flow code on the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'ChannelCode', 'in' => 'query', 'schema' => ['description' => 'The message channel code. This is the channel ID. View the channel ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'cams-8c8*********'], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The message channel type. Valid values:'."\n" ."\n" .'- INSTAGRAM'."\n" ."\n" .'- WHATSAPP'."\n" ."\n" .'- MESSENGER'."\n" ."\n" .''."\n" ."\n" .'- VIBER'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'WHATSAPP'], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of phone numbers, PageIds, AccountIds, or ServiceIds for the channel instance.', 'type' => 'array', 'items' => ['description' => 'A single phone number, PageId, AccountId, or ServiceId.'."\n" ."\n" .'- If \\`ChannelType\\` is \\`WHATSAPP\\`, pass the business phone number of the WhatsApp channel instance. View the business phone number on the **Phone Number Management** page by navigating to **Channel Management** > **Manage** > **WABA Management**.'."\n" ."\n" .'- If \\`ChannelType\\` is \\`MESSENGER\\`, pass the PageId (public homepage ID) of the Messenger channel instance. View the Page ID on the **Public Homepage** page by navigating to **Channel Management** > **Manage**.'."\n" ."\n" .'- If \\`ChannelType\\` is \\`INSTAGRAM\\`, pass the AccountId (professional account ID) of the Instagram channel instance. View the Account ID on the **Professional Account** page by navigating to **Channel Management** > **Manage**.'."\n" ."\n" .''."\n" ."\n" .'- If \\`ChannelType\\` is \\`VIBER\\`, pass the ServiceId (service number ID) of the Viber channel instance. View the Service ID on the **Service Number Management** page by navigating to **Channel Management** > **Manage**.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '86188********'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['description' => 'The WABA account ID, PageId, AccountId, or ServiceId.'."\n" ."\n" .'- If \\`ChannelType\\` is \\`WHATSAPP\\`, pass the WABA account ID. View the WABA account ID on the **WABA Management** page by navigating to **Channel Management** > **Manage**.'."\n" ."\n" .'- If \\`ChannelType\\` is not \\`WHATSAPP\\`, pass the PageId for \\`MESSENGER\\` or the AccountId for \\`INSTAGRAM\\`. For \\`VIBER\\`, pass the ServiceId.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1952************'], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. On the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to go to the flow editor canvas and view the flow version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Model' => ['description' => 'Indicates whether the result was successful. Valid values:'."\n" ."\n" .'- true: Yes.'."\n" ."\n" .'- false: No.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Bind Phone Numbers or Instances to Flow', 'summary' => 'Attaches a phone number or a business account ID to a flow.', 'description' => '- Call this API operation to attach a phone number or a business account ID to a flow. You can also manually attach them on the **Settings** page in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before you call this API operation, make sure that you have created a flow and a message channel of the corresponding type.'."\n" ."\n" .'- For a WhatsApp channel, you must have completed [WhatsApp Business Account (WABA) registration and binding](~~172335~~) and [added a phone number](~~2656131~~).'."\n" ."\n" .'- For a Messenger channel, you must have [connected a public homepage account](~~2837713~~).'."\n" ."\n" .'- For an Instagram channel, you must have [connected a professional account](~~2837720~~).'."\n" ."\n" .''."\n" ."\n" .'- For a Viber channel, you must have [requested a service number](~~2807995~~).'."\n" ."\n" .'', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowBindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'FlowRebindPhone' => [ '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' => 'The flow code. You can view it on the [Flow Builder](https://chatapp.console.aliyun.com/ChatFlowBuilder) page.', 'type' => 'string', 'required' => true, 'example' => '9ccc41**************************'."\n", 'title' => ''], ], [ 'name' => 'ChannelCode', 'in' => 'query', 'schema' => ['description' => 'The message channel code, which is the channel ID. You can view the channel ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-8c8*********'."\n", 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The message channel type. Valid values:'."\n" ."\n" .'- INSTAGRAM'."\n" ."\n" .'- WHATSAPP'."\n" ."\n" .'- MESSENGER'."\n" ."\n" .'- VIBER', 'type' => 'string', 'required' => true, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of phone numbers, PageIds, or AccountIds, or ServiceIds under the channel instance.', 'type' => 'array', 'items' => ['description' => 'A single phone number, PageId, or AccountId, or ServiceId.'."\n" ."\n" .'- If ChannelType is set to WHATSAPP, specify the merchant phone number under the WhatsApp channel instance. You can view the merchant phone number on the Channel Management > Manage > WABA Management > Number Management page.'."\n" ."\n" .'- If ChannelType is set to MESSENGER, specify the PageId (public page ID) under the Messenger channel instance. You can view the page ID on the Channel Management > Manage > Public Pages page.'."\n" ."\n" .'- If ChannelType is set to INSTAGRAM, specify the AccountId (professional account ID) under the Instagram channel instance. You can view the account ID on the Channel Management > Manage > Professional Accounts page.'."\n" ."\n\n" ."\n" .'- If ChannelType is set to VIBER, specify the ServiceId (service account ID) under the Viber channel instance. You can view the service account ID on the Channel Management > Manage > Service Account Management page.', 'type' => 'string', 'required' => false, 'example' => '86188********', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['description' => 'The WABA account ID, PageId, or AccountId, or ServiceId.'."\n" ."\n" .'- If ChannelType is set to WHATSAPP, specify the WABA account ID. You can view the WABA account ID on the Channel Management > Manage > WABA Management page.'."\n" ."\n" .'- If ChannelType is not set to WHATSAPP, specify the PageId for MESSENGER, the AccountId for INSTAGRAM, or the ServiceId for VIBER.', 'type' => 'string', 'required' => true, 'example' => '1952************'."\n", 'title' => ''], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. On the [Flow Builder](https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to open the flow builder canvas and view the flow version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'Model' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: The operation is successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: The operation is successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Rebind a phone number or merchant account ID to a flow', 'summary' => 'Rebinds a phone number or merchant account ID to a flow.', 'description' => '- You can call this operation to rebind a phone number or merchant account ID to a flow that already has a binding. You can also manually rebind on the [**Flow Builder**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **Settings** page.'."\n" ."\n" .'- Before calling this operation, make sure that your flow already has a phone number or merchant account ID bound to it.'."\n" ."\n" .'- If you are binding a phone number or merchant account ID to a flow for the first time, use the [FlowBindPhone](~~2937190~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowRebindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'FlowUnbindPhone' => [ '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' => 'The flow code. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9ccc41**************************'."\n"], ], [ 'name' => 'PhoneNumbers', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of phone numbers, Page IDs, Account IDs, or Service IDs for the channel instance.', 'type' => 'array', 'items' => ['description' => 'A single phone number, Page ID, Account ID, or Service ID.'."\n" ."\n" .'- If you set \\`ChannelType\\` to \\`WHATSAPP\\`, pass the business phone number of the WhatsApp channel instance. View the business phone number on the Number Management page. To find this page, go to Channel Management > Management > WABA Management.'."\n" ."\n" .'- If you set \\`ChannelType\\` to \\`MESSENGER\\`, pass the Page ID of the Messenger channel instance. View the Page ID on the Public Homepage page. To find this page, go to Channel Management > Management.'."\n" ."\n" .'- If you set \\`ChannelType\\` to \\`INSTAGRAM\\`, pass the AccountId of the Instagram channel instance. View the Account ID on the Professional Account page. To find this page, go to Channel Management > Management.'."\n" ."\n" .''."\n" ."\n" .'- If you set \\`ChannelType\\` to \\`VIBER\\`, pass the ServiceId of the Viber channel instance. View the Service ID on the Service Number Management page. To find this page, go to Channel Management > Management.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '86188********'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. In the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder), click the flow name to go to the orchestration canvas and view the flow version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The message channel type. Valid values:'."\n" ."\n" .'- INSTAGRAM'."\n" ."\n" .'- WHATSAPP'."\n" ."\n" .'- MESSENGER'."\n" ."\n" .''."\n" ."\n" .'- VIBER'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'WHATSAPP'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Model' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Unbind Phone Number or Instance from Flow', 'summary' => 'Unbinds a phone number or business account ID from a flow.', 'description' => '- Before you call this operation, ensure that the flow is unpublished. If the flow is published, you can unpublish it manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) by clicking the flow name to open the orchestration canvas. Alternatively, you can call the [OfflineFlowVersion](~~2937198~~) operation to unpublish the flow.'."\n" ."\n" .'- You can call this operation to unbind a phone number or business account ID from a flow. You can also perform this action manually on the **Settings** page in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before you call this operation, ensure that a phone number or business account ID is bound to the flow.'."\n" ."\n" .'- If no phone number or business account ID is bound to the flow, you can bind one manually on the **Settings** page in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) or call the [FlowBindPhone](~~2937190~~) operation.'."\n" ."\n" .'- After a phone number or business account ID is unbound from a flow, the flow cannot be published. You must bind a new phone number or business account ID to the flow before you can publish it.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowUnbindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"\\",\\n \\"Model\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GeneratePresignedUrl' => [ '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' => 'The OSS path.', 'type' => 'string', 'required' => true, 'example' => '/aaa/111/aa.png', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The additional message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866**', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'The material path.'."\n" ."\n" .'> For Viber, the recommended image size is 800 × 800.', 'type' => 'string', 'example' => 'https://public-oss.es**/camera_609.png', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve a temporary URL', 'summary' => 'Retrieves a temporary URL.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:GeneratePresignedUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'viberOpen', 'description' => '', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'cams-***', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486***', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'AuditResult' => ['type' => 'string', 'example' => 'pass', 'description' => '', 'title' => ''], 'Creator' => ['type' => 'string', 'example' => '11', 'description' => '', 'title' => ''], 'GmtCreate' => ['type' => 'string', 'example' => '1789200', 'description' => '', 'title' => ''], 'SubscriberCode' => ['type' => 'string', 'example' => '345436456546', 'description' => '', 'title' => ''], 'MaapServiceNo' => ['type' => 'string', 'example' => '475646', 'description' => '', 'title' => ''], 'State' => ['type' => 'string', 'example' => 'A', 'description' => '', 'title' => ''], 'AuditTime' => ['type' => 'string', 'example' => '20250106', 'description' => '', 'title' => ''], 'GmtModifier' => ['type' => 'string', 'example' => '20251624', 'description' => '', 'title' => ''], 'AuditRecord' => [ 'type' => 'object', 'properties' => [ 'ContactMail' => ['type' => 'string', 'example' => 'qqemail@gmail.com', 'description' => '', 'title' => ''], 'CompanyLegalName' => ['type' => 'string', 'example' => 'xxxxcompany', 'description' => '', 'title' => ''], 'LetterGuarantee' => ['type' => 'string', 'example' => 'https://www.xxxxxxx', 'description' => '', 'title' => ''], 'IndustryInvolved' => ['type' => 'string', 'example' => 'it', 'description' => '', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '["12|es"]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'MessageEnableDate' => ['type' => 'string', 'example' => '2025-11-01', 'description' => '', 'title' => ''], 'CompanyLegalPerson' => ['type' => 'string', 'example' => 'jack', 'description' => '', 'title' => ''], 'CompanyAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyAddress' => ['type' => 'string', 'example' => 'xxxxcompany', 'description' => '', 'title' => ''], 'CompanyAddressTitle' => ['type' => 'string', 'example' => '111', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'CompanyRegisteredCountry' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '[zh]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'AgeLimit' => ['type' => 'string', 'example' => 'eighteenUp', 'description' => '', 'title' => ''], 'IndustryDescription' => ['type' => 'string', 'example' => 'xxx', 'description' => '', 'title' => ''], 'WebAddress' => ['type' => 'string', 'example' => 'www.xxxxx', 'description' => '', 'title' => ''], 'EnableAutoReply' => ['type' => 'string', 'example' => 'N', 'description' => '', 'title' => ''], 'NowRecovery' => ['type' => 'string', 'example' => 'n', 'description' => '', 'title' => ''], 'RecoveryDate' => ['type' => 'string', 'example' => '2025-111-06', 'description' => '', 'title' => ''], 'BusinessAccountName' => ['type' => 'string', 'example' => 'aaa', 'description' => '', 'title' => ''], 'ApplyReason' => ['type' => 'string', 'example' => 'bnv', 'description' => '', 'title' => ''], 'Logo' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '[]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'ReplyContent' => ['type' => 'string', 'example' => 'aaaqq', 'description' => '', 'title' => ''], 'CompanyProfile' => ['type' => 'string', 'example' => 'CompanyProfile', 'description' => '', 'title' => ''], 'MessageDialogueIntroduction' => ['type' => 'string', 'example' => 'MessageDialogueIntroduction ', 'description' => '', 'title' => ''], 'CompanyTel' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyTelNumber' => ['type' => 'string', 'example' => '143243**', 'description' => '', 'title' => ''], 'CompanyTelTitle' => ['type' => 'string', 'example' => 'example', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'MessageDestinationCountry' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '["61|es]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'MessageSessionName' => ['type' => 'string', 'example' => 'Message Session Name', 'description' => '', 'title' => ''], 'SuspensionDate' => ['type' => 'string', 'example' => 'SuspensionDate', 'description' => '', 'title' => ''], 'CompanyEnglishName' => ['type' => 'string', 'example' => 'Company English Name', 'description' => '', 'title' => ''], ], 'example' => '', 'description' => '', 'title' => '', ], 'Id' => ['type' => 'string', 'example' => 'id', 'description' => '', 'title' => ''], 'Modifier' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''], 'RequestNo' => ['type' => 'string', 'example' => '45345435435', 'description' => '', 'title' => ''], 'RequestType' => ['type' => 'string', 'example' => 'viber_open', 'description' => '', 'title' => ''], 'AliUid' => ['type' => 'string', 'example' => '21432', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetAuditRequestByTypeUnAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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\\": \\"qqemail@gmail.com\\",\\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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetAutoGeneratedTemplate' => [ 'summary' => 'Retrieves auto-generated templates.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of an ISV sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-xx**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The unique request ID. It can be used to troubleshoot issues.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'NextToken' => ['description' => 'The token to retrieve the next page of results. This value is returned only if more results are available.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'List' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'additionalProperties' => ['description' => 'The attributes of the template.', 'type' => 'any', 'example' => '[]', 'title' => ''], 'description' => 'The template.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The record list.', 'title' => '', ], 'MaxResults' => ['description' => 'The maximum number of entries returned in the current request.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', 'description' => 'The response data.', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- An `OK` value indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see the [error code list](~~196974~~).', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetAutoGeneratedTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetAutoGeneratedTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Message\\": \\"example\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"example\\",\\n \\"List\\": [\\n {\\n \\"key\\": \\"[]\\"\\n }\\n ],\\n \\"MaxResults\\": 20\\n },\\n \\"Code\\": \\"example\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'GetChatFlowMetric' => [ 'summary' => 'Retrieves 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' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'ALICOM_OPAAS', 'title' => '', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: an empty collection.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'From', 'in' => 'query', 'schema' => ['description' => 'The start time. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1751299200', 'title' => ''], ], [ 'name' => 'To', 'in' => 'query', 'schema' => ['description' => 'The end time. This value is a UNIX timestamp. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1751385599', 'title' => ''], ], [ 'name' => 'FlowCode', 'in' => 'query', 'schema' => ['description' => 'The flow code. You can view the flow code on the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page.', 'type' => 'string', 'required' => false, 'example' => '9ccc41**************************', 'title' => ''], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. On the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to open the canvas and view the flow version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'MetricName', 'in' => 'query', 'schema' => [ 'description' => 'The metric name. Valid values:'."\n" ."\n" .'- nodeUsageStatistics: node usage statistics.'."\n" ."\n" .'- nodeErrorDetails: node error details.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'nodeUsageStatistics', 'title' => '', ], ], [ 'name' => 'MetricParam', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The extended parameter for the metric query. When MetricName is set to nodeErrorDetails, pass in a JSON string. Valid values for the JSON fields:'."\n" ."\n" .'- pageNo: the current page number.'."\n" ."\n" .'- pageSize: the number of entries per page.'."\n" ."\n" .'- nodeId: the node ID. On the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to open the canvas and copy the node ID.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "pageNo": 1,'."\n" .' "pageSize": 20,'."\n" .' "nodeId": "SendWhatsAppMessage#H7fKq5rM"'."\n" .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => ['description' => 'The returned data object.', 'type' => 'object', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve chatFlow runtime data', 'description' => '- Before calling this operation, make sure that the flow you created is online and has been triggered.'."\n" ."\n" .'- If your flow is not online, go to the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page, click the flow name to open the canvas, and manually bring the flow online. Alternatively, call the [OnlineFlowVersion](~~2937203~~) operation to bring the flow online.'."\n" ."\n" .'- For flows with a manual trigger type, call the [TriggerChatFlow](~~2859101~~) operation to trigger the flow, or go to the [Marketing Activity Management](https://chatapp.console.aliyun.com/MarketingActivityManagement) page and trigger the flow by associating it with a campaign.'."\n" ."\n" .'- For flows with a non-manual trigger type, you do not need to manually trigger the flow. The flow is automatically triggered when a message is sent to the bound business account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatFlowMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetChatFlowTemplate' => [ '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' => 'The ID of the template. You can call the [ListChatFlowTemplate](~~2937208~~) operation to obtain the template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '2'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The code of the business tenant. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query ChatFlow Template Details', 'summary' => 'Queries the details of a flow template.', 'description' => '- You can call this operation to query the details of a flow template. You can also go to the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **View Templates** page and click a template name to view its details.'."\n" ."\n" .'- After you view the details of a template on the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **View Templates** page, you can use the template to create a flow.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:GetChatFlowTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetChatappOpenStatus' => [ 'summary' => 'Queries the activation status of 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' => 'The request ID generated by Alibaba Cloud for this request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'OpenStatus' => ['description' => 'The activation status.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Query chatApp activation status', 'changeSet' => [ ['createdAt' => '2022-03-28T07:32:12.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappOpenStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"OpenStatus\\": true\\n}","type":"json"}]', ], 'GetChatappPhoneNumberMetric' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195300', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV.', 'type' => 'string', 'required' => false, 'example' => 'skdi3kksloslikd****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channels Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channels Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-************', 'title' => ''], ], [ 'name' => 'Granularity', 'in' => 'query', 'schema' => [ 'description' => 'The metric granularity. Valid values:'."\n" .'- DAILY: collects metrics on a daily basis.'."\n" .'- HALF_HOUR: collects metrics every half hour.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'DAILY', 'title' => '', ], ], [ 'name' => 'Start', 'in' => 'query', 'schema' => ['description' => 'The query start time. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1756742399000', 'title' => ''], ], [ 'name' => 'End', 'in' => 'query', 'schema' => ['description' => 'The query end time. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1758902399000', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The business phone number. This is the number used to send messages, which can be viewed on the [**Channels Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channels Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **WABA Management** > **Phone Number Management** page.', 'type' => 'string', 'required' => false, 'example' => '861380000****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The list of returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'DeliveredCount' => ['description' => 'The number of delivered messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'Start' => ['description' => 'The start time of the metric collection period. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1669619491000', 'title' => ''], 'PhoneNumber' => ['description' => 'The business phone number.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'End' => ['description' => 'The end time of the metric collection period. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1667196043904', 'title' => ''], 'Granularity' => [ 'description' => 'The metric granularity.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'DAILY', 'title' => '', ], 'SentCount' => ['description' => 'The number of sent messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [API error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Query phone number sending volume metrics', 'summary' => 'Queries the message sending volume metrics for a WhatsApp channel phone number.', 'description' => '- This operation can only query the sending volume metrics for phone numbers on WhatsApp channels.'."\n" ."\n" .'- You can call this operation to query phone number sending volume metrics, or view them in the [**Channels Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channels Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Customer Statistics Daily Report** page.'."\n" ."\n\n" .'- Before calling this operation, call the [EnableWhatsAppROIMetric](~~2557789~~) operation to enable WhatsApp ROI metric collection. After enabling, at least one day is required before statistics become available. Message sending volume metrics for messages sent before enabling are not collected.'."\n" ."\n" .'- After enabling WhatsApp ROI metric collection, ensure that your channel has successfully sent messages. You can send messages on the [**Channels Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channels Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Send Message** page, or by calling the [SendChatappMessage](~~432208~~) or [SendChatappMassMessage](~~447926~~) operation.'."\n" ."\n\n" .'### QPS limit'."\n" .'The single-user QPS limit for this operation is 50 calls per second. Requests that exceed this limit are throttled, which may affect your business. Call this operation as appropriate.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '75', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappPhoneNumberMetric'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappPhoneNumberMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetChatappPhoneNumberSetting' => [ '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' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'C29393993****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '86138***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud for this request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '42602478-F7C1-58D2-AFFE-88F7A18***6', 'title' => ''], 'Model' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '86138****', 'title' => ''], 'MarketingPaused' => ['description' => 'Indicates whether marketing is paused.', 'type' => 'string', 'example' => 'Y', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Get chatApp phone number configuration', 'summary' => 'Retrieves other controls for a ChatApp phone number.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappPhoneNumberSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetChatappTemplateDetail' => [ 'summary' => 'Retrieves the details of a Chat App Message Service 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 template.', 'type' => 'string', 'required' => false, 'example' => '****4b5c79c9432497a075bdfca36bf5'], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The language of the template. For detailed language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'en_US'], ], [ 'name' => 'CustWabaId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The WabaId of the ISV customer.'."\n" ."\n" .'> This parameter is deprecated. Use CustSpaceId instead.', 'type' => 'string', 'deprecated' => true, 'example' => '65921621816****'."\n", 'required' => false], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ISV verification code, which is used to verify whether the sub-account is authorized by the ISV.', 'type' => 'string', 'example' => 'skdi3kksloslikdkkdk', 'required' => false], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The SpaceId of the ISV sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'docRequired' => true, 'example' => '28251486512358****', 'required' => true], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The templatetype.'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'- **VIBER**', 'type' => 'string', 'example' => 'WHATSAPP', 'required' => false], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The name of the template.', 'type' => 'string', 'example' => 'test_name', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '744c4b5c79c9432497a075bdfca3****'], 'Code' => ['title' => '', 'description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Category' => ['title' => '', 'description' => 'The WhatsApp template category. Valid values:'."\n" ."\n" .'- **UTILITY**: transaction-related.'."\n" ."\n" .'- **MARKETING**: marketing template.'."\n" ."\n" .'- **AUTHENTICATION**: identity verification.'."\n" ."\n" .'Viber template category. Valid values:'."\n" .'- **text**: text only'."\n" ."\n" .'- **image**: image only'."\n" ."\n" .'- **text\\_image_button**: text + image + button'."\n" ."\n" .'- **text_button**: text + button'."\n" ."\n" .'- **document**: file'."\n" ."\n" .'- **video**: video'."\n" ."\n" .'- **text_video**: text + video'."\n" ."\n" .'- **text\\_video_button**: text + video + button'."\n" ."\n" .'- **text_image**: text + image'."\n" ."\n" .'> When the Viber template value is text_video_button, the button does not open a web page. Instead, it opens the video of the current message within the web page. Therefore, you do not need to enter any address information in the URL of the button.', 'type' => 'string', 'example' => 'UTILITY'], 'TemplateCode' => ['title' => '', 'description' => 'The code of the template.', 'type' => 'string', 'example' => '744c4b5c79c9432497a075bdfca3****'], 'Name' => ['title' => '', 'description' => 'The name of the template.', 'type' => 'string', 'example' => 'hello_whatsapp'], 'Language' => ['title' => '', 'description' => 'The language of the template. For detailed language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'example' => 'en_US'], 'Example' => [ 'title' => '', 'description' => 'The variable examples.', 'type' => 'object', 'additionalProperties' => ['description' => 'The actual values corresponding to the template variables. The parameter format is JSON.', 'type' => 'string', 'example' => '{\\"textVariable\\":\\"text\\",\\"linkVariable\\":\\"https://image.developer.aliy\\"}', 'title' => ''], 'example' => '', ], 'AuditStatus' => ['title' => '', 'description' => 'The audit status. Valid values:'."\n" ."\n" .'- **pass**: Approved.'."\n" ."\n" .'- **fail**: Rejected.'."\n" ."\n" .'- **auditing**: Under review.'."\n" ."\n" .'- **unaudit**: Review suspended.', 'type' => 'string', 'example' => 'pass'], 'Components' => [ 'title' => '', 'description' => 'The list of message template components.', 'type' => 'array', 'items' => [ 'description' => 'The message template component.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The component type.'."\n" ."\n" .'- **BODY**'."\n" ."\n" .'- **HEADER**'."\n" ."\n" .'- **FOOTER**'."\n" ."\n" .' - **BUTTONS**'."\n" ."\n" .'- **CAROUSEL**'."\n" ."\n" .'- **LIMITED_TIME_OFFER**'."\n" ."\n" .'> - For WhatsApp templates, the character length of the **BODY** component cannot exceed 1024 characters. The character length of the **HEADER** and **FOOTER** components cannot exceed 60 characters.'."\n" .'> - For Viber templates, the **FOOTER**, **CAROUSEL**, and **LIMITED_TIME_OFFER** types are invalid.'."\n" .'> - In Viber templates, images, videos, and files are placed in the **HEADER** (the device displays images below the text).', 'type' => 'string', 'example' => 'BODY'], 'Url' => ['title' => '', 'description' => 'The media URL.', 'type' => 'string', 'example' => 'https://image.developer.aliyundoc.com'], 'Text' => ['title' => '', 'description' => 'The text of the message to be sent.', 'type' => 'string', 'example' => 'hello'], 'Caption' => ['title' => '', 'description' => 'The description of the file.', 'type' => 'string', 'example' => 'example'], 'FileName' => ['title' => '', 'description' => 'The name of the file.', 'type' => 'string', 'example' => 'example'], 'Format' => ['title' => '', 'description' => 'The format.', 'type' => 'string', 'example' => 'TEXT'], 'Buttons' => [ 'title' => '', 'description' => 'The list of buttons. Applicable only to the **BUTTONS** component.'."\n" ."\n" .'> WhatsApp button quantity rules:'."\n" .'> - When the WhatsApp category is MARKETING or UTILITY, a maximum of 10 buttons are allowed.'."\n" .'> - Only one PHONE_NUMBER button is allowed.'."\n" .'> - A maximum of two URL buttons are allowed.'."\n" .'> - QUICK_REPLY buttons cannot appear in a mixed order with PHONE_NUMBER or URL buttons.', 'type' => 'array', 'items' => [ 'description' => 'The component list.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The button type.'."\n" ."\n" .'- **PHONE_NUMBER**: call button'."\n" ."\n" .'- **URL**: web page button'."\n" ."\n" .'- **QUICK_REPLY**: quick reply button'."\n" ."\n" .'- **COPY_CODE**: copy verification code or coupon code'."\n" ."\n" .'- **ONE_TAP**: autofill button for AUTHENTICATION templates'."\n" ."\n" .'- **ZERO_TAP**: autofill button for AUTHENTICATION templates'."\n" ."\n" .'- **MPM**: multi-product catalog'."\n" ."\n" .'- **CATALOG**: catalog'."\n" ."\n" .'- **FLOW**: open WhatsApp flow'."\n" ."\n" .'> - For WhatsApp templates with Category set to AUTHENTICATION, only one button is allowed, and the type can only be COPY_CODE or ONE_TAP. If the type is COPY_CODE, Text is required. If the type is ONE_TAP, Text (displayed when the target application is not installed on the device, indicating the name of the copy verification code button), SignatureHash, PackageName, and AutofillText are required.'."\n" .'> - Viber templates allow only one button, and it must be of the URL type.', 'type' => 'string', 'example' => 'PHONE_NUMBER'], 'Text' => ['title' => '', 'description' => 'The display name of the button.', 'type' => 'string', 'example' => 'example'], 'PhoneNumber' => ['title' => '', 'description' => 'The phone number. Valid only when the button type is **PHONE_NUMBER**.', 'type' => 'string', 'example' => '+861398745****'], 'Url' => ['title' => '', 'description' => 'The URL that is accessed when the link button is clicked.', 'type' => 'string', 'example' => 'https://example.com'."\n"], 'UrlType' => ['title' => '', 'description' => 'The URL type.'."\n" ."\n" .'- **static**: static.'."\n" ."\n" .'- **dynamic**: dynamic.', 'type' => 'string', 'example' => 'static'], 'SignatureHash' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The signature hash value used by WhatsApp to launch the application.', 'type' => 'string', 'example' => '2993839'], 'PackageName' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The package name of the application launched by WhatsApp.', 'type' => 'string', 'example' => 'com.aliyun'], 'AutofillText' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is Authentication and Button Type is ONE_TAP. The button text for the WhatsApp autofill operation.', 'type' => 'string', 'example' => 'Autofill'], 'IsOptOut' => ['title' => '', 'description' => 'Valid when the WhatsApp template Category is Marketing and Button Type is QUICK_REPLY. Indicates that the button is a marketing opt-out button. If the customer clicks this button and the send control operation is configured on the Chat App platform, subsequent marketing messages will not be sent to the customer.', 'type' => 'boolean', 'example' => 'false'], 'ExtendAttrs' => [ 'title' => '', 'description' => 'The extended attributes.', 'type' => 'object', 'properties' => [ 'NextTemplateCode' => ['title' => '', 'description' => 'The next template code.', 'type' => 'string', 'example' => '20939920093993'], 'NextTemplateName' => ['title' => '', 'description' => 'The next template name.', 'type' => 'string', 'example' => 'abc'], 'NextLanguageCode' => ['title' => '', 'description' => 'The next template language.', 'type' => 'string', 'example' => 'en'], 'Action' => ['title' => '', 'description' => 'The event type.', 'type' => 'string', 'example' => 'nextCard'], 'IntentCode' => ['title' => '', 'description' => 'The intent code.', 'type' => 'string', 'example' => 'test'], ], 'example' => '', ], 'CouponCode' => ['title' => '', 'description' => 'The coupon code.', 'type' => 'string', 'example' => '202039ksjs'], 'FlowId' => ['title' => '', 'description' => 'Flow ID', 'type' => 'string', 'example' => '3838292983'], 'FlowAction' => ['title' => '', 'description' => 'The flow data event type. Valid values:'."\n" ."\n" .'- NAVIGATE: navigation'."\n" ."\n" .'- DATA_EXCHANGE: data exchange', 'type' => 'string', 'example' => 'NAVIGATE'], 'NavigateScreen' => ['title' => '', 'description' => 'The navigate screen. Required when FlowAction is set to NAVIGATE.', 'type' => 'string', 'example' => 'DETAILS'], 'SupportedApps' => [ 'title' => '', 'description' => 'The applications supported by ONE_TAP/ZERO_TAP verification code.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The applications supported by ONE_TAP/ZERO_TAP verification code.', 'type' => 'object', 'properties' => [ 'SignatureHash' => ['title' => '', 'description' => 'The package signature hash.', 'type' => 'string', 'example' => '29kdkeik939'], 'PackageName' => ['title' => '', 'description' => 'The package name.', 'type' => 'string', 'example' => 'com.test'], ], 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ThumbUrl' => ['title' => '', 'description' => 'The thumbnail for Viber video messages.', 'type' => 'string', 'example' => 'https://img.png'], 'Duration' => ['title' => '', 'description' => 'The video duration for Viber video messages. Valid values: 0 to 600.', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], 'FileType' => ['title' => '', 'description' => 'The file type for Viber file messages.', 'type' => 'string', 'example' => 'docx'], 'Latitude' => ['title' => '', 'description' => 'The latitude of the location.', 'type' => 'string', 'example' => '28.001'], 'Longitude' => ['title' => '', 'description' => 'The longitude of the location.', 'type' => 'string', 'example' => '120.002'], 'LocationName' => ['title' => '', 'description' => 'The name of the location.', 'type' => 'string', 'example' => 'hangzhou'], 'LocationAddress' => ['title' => '', 'description' => 'The address of the location.', 'type' => 'string', 'example' => 'hangzhou'], 'AddSecretRecommendation' => ['title' => '', 'description' => 'Valid for WhatsApp templates when Category is Authentication and Component Type is Body. Displays a recommendation on the Body not to share the verification code with others.', 'type' => 'boolean', 'example' => 'false'], 'CodeExpirationMinutes' => ['title' => '', 'description' => 'The verification code validity period (in minutes) for WhatsApp Authentication templates. Valid only for WhatsApp messages when Category is Authentication and Component Type is Footer. This information is displayed in the Footer.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '90', 'minimum' => '1', 'example' => '5'], 'hasExpiration' => ['title' => '', 'description' => 'Specifies whether the coupon code has an expiration time in limited-time offer (LTO) templates.', 'type' => 'boolean', 'example' => 'true'], 'OfferExpirationTimeMs' => ['title' => '', 'description' => 'The coupon code expiration variable for LTO templates.', 'type' => 'string', 'example' => '$(offerExpirationTimeMs)'], 'Cards' => [ 'title' => '', 'description' => 'The list of carousel cards.', 'type' => 'array', 'items' => [ 'description' => 'The carousel template card list.', 'type' => 'object', 'properties' => [ 'CardComponents' => [ 'title' => '', 'description' => 'The list of card components.', 'type' => 'array', 'items' => [ 'description' => 'The component list within a carousel card.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The component type.', 'type' => 'string', 'example' => 'HEADER'], 'Text' => ['title' => '', 'description' => 'The text content of the card.', 'type' => 'string', 'example' => 'Body'], 'Url' => ['title' => '', 'description' => 'The web address.', 'type' => 'string', 'example' => 'https://aliyun.com'], 'Format' => ['title' => '', 'description' => 'The header type in carousel templates. Only IMAGE and VIDEO are supported. All cards must have the same header type.', 'type' => 'string', 'example' => 'HEADER'], 'Buttons' => [ 'title' => '', 'description' => 'The list of card buttons.', 'type' => 'array', 'items' => [ 'description' => 'The button object.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The button type for carousel templates. Valid values: URL, PHONE_NUMBER, and QUICK_REPLY.', 'type' => 'string', 'example' => 'URL'], 'Text' => ['title' => '', 'description' => 'The button content.', 'type' => 'string', 'example' => 'example'], 'Url' => ['title' => '', 'description' => 'The URL accessed when the button is clicked.', 'type' => 'string', 'example' => 'https://aliyun.com'], 'UrlType' => ['title' => '', 'description' => 'The URL type. Valid values:'."\n" .' '."\n" .'- static: static.'."\n" ."\n" .'- dynamic: dynamic.', 'type' => 'string', 'example' => 'static'], 'PhoneNumber' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '+861380005****'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'maxItems' => 10, 'minItems' => 0, 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TemplateType' => ['title' => '', 'description' => 'The templatetype.'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'- **VIBER**', 'type' => 'string', 'example' => 'WHATSAPP'], 'QualityScore' => [ 'title' => '', 'description' => 'The template quality.'."\n" .'- RED (low quality)'."\n" .'- YELLOW (medium quality)'."\n" .'- UNKNOWN (unknown quality)'."\n" .'- GREEN (high quality)', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'GREEN', ], 'MessageSendTtlSeconds' => ['title' => '', 'description' => 'The message validity period when sending messages with WhatsApp Authentication templates.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '600', 'minimum' => '60', 'example' => '120'], 'Reason' => ['title' => '', 'description' => 'The reason why the template was rejected during review.', 'type' => 'string', 'example' => 'None'], 'CategoryChangePaused' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'AllowSend' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], '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' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","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\\": \\"hello\\",\\n \\"Caption\\": \\"example\\",\\n \\"FileName\\": \\"example\\",\\n \\"Format\\": \\"TEXT\\",\\n \\"Buttons\\": [\\n {\\n \\"Type\\": \\"PHONE_NUMBER\\",\\n \\"Text\\": \\"example\\",\\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\\": \\"hangzhou\\",\\n \\"LocationAddress\\": \\"hangzhou\\",\\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\\": \\"example\\",\\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\\": false,\\n \\"AllowSend\\": false\\n },\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', 'title' => 'Query chat app template details', 'description' => '### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as needed.', 'changeSet' => [ ['createdAt' => '2025-06-11T13:05:34.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-26T05:51:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-21T01:24:03.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-10-19T06:41:47.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-09-14T12:01:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-08-17T12:01:00.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:57.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-25T12:54:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-08T11:38:22.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-13T11:48:07.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-08T12:37:07.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2022-03-08T12:37:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappTemplateDetail'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappTemplateDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetChatappTemplateMetric' => [ 'summary' => 'Retrieves metrics related to marketing-type templates.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '195220', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], ], 'parameters' => [ [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['description' => 'The template code. You can view the template code on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Template Design** page.', 'type' => 'string', 'required' => true, 'example' => '1100***************'."\n", 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The template language. For more languages, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV.', 'type' => 'string', 'required' => false, 'example' => 'skdi3kksloslikd****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer, which is also the channel ID. You can view it on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) interface.', 'type' => 'string', 'required' => false, 'example' => 'cams-************'."\n", 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => [ 'description' => 'The templatetype. Valid values:'."\n" .'- WHATSAPP'."\n" ."\n" .'> If this parameter is not specified, the default value is WHATSAPP.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => '', ], ], [ 'name' => 'Granularity', 'in' => 'query', 'schema' => [ 'description' => 'The metric granularity. Valid values:'."\n" .'- DAILY: collects metrics on a daily basis.'."\n" .'- HALF_HOUR: collects metrics every half hour.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'DAILY', 'title' => '', ], ], [ 'name' => 'Start', 'in' => 'query', 'schema' => ['description' => 'The start time of the query. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693107714687', 'title' => ''], ], [ 'name' => 'End', 'in' => 'query', 'schema' => ['description' => 'The end time of the query. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1693407714687', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The list of returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => '1100***************', 'title' => ''], 'DeliveredCount' => ['description' => 'The number of delivered messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], 'Language' => ['description' => 'The template language.', 'type' => 'string', 'example' => 'en', 'title' => ''], 'Cliented' => [ 'description' => 'The list of button click statistics.', 'type' => 'array', 'items' => [ 'description' => 'The button click statistics.', 'type' => 'object', 'properties' => [ 'Type' => [ 'description' => 'The button type. Valid values:'."\n" .'- phone_number_button: a phone call button.'."\n" .'- url_button: a URL button.'."\n" .'- quick_relpy_button: a quick reply button.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'quick_reply_button', 'title' => '', ], 'ButtonContent' => ['description' => 'The button text.', 'type' => 'string', 'example' => 'reply', 'title' => ''], 'Count' => ['description' => 'The number of clicks.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Start' => ['description' => 'The start time of the metric collection period. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1673919240001', 'title' => ''], 'End' => ['description' => 'The end time of the metric collection period. This value is a timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1668138331485', 'title' => ''], 'SentCount' => ['description' => 'The number of sent messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'ReadCount' => ['description' => 'The number of read messages.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Retrieve marketing template metrics', 'description' => '- This operation can only query metrics for marketing templates of WhatsApp channels.'."\n" ."\n" .'- Before calling this operation, call the [EnableWhatsAppROIMetric](~~2557789~~) operation to enable WhatsApp ROI metric collection. After enabling, statistical data requires at least one day to become available. Metrics for marketing templates sent before enabling are not collected.'."\n" ."\n" .'- After enabling WhatsApp ROI metric collection, make sure that the marketing templates of your created channels have successfully sent messages. You can send messages on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Send Message** page, or by calling the [SendChatappMessage](~~432208~~) or [SendChatappMassMessage](~~447926~~) operation.'."\n" ."\n" .'### QPS limit'."\n" .'The single-user QPS limit for this operation is 50 calls per second. Requests that exceed this limit are throttled, which may affect your business. Call this operation as appropriate.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:50.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappTemplateMetric'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappTemplateMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], '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' => ['description' => 'The space ID of ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Access denied for detailed information.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'SecurityToken' => ['description' => 'The security token.', 'type' => 'string', 'example' => 'dkdieiii****', 'title' => ''], 'Expire' => ['description' => 'The timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], 'BucketName' => ['description' => 'The name of the bucket to which a file is uploaded in OSS.', 'type' => 'string', 'example' => 'oss', 'title' => ''], 'AccessKeyId' => ['description' => 'The AccessKey ID that is used to authorize a user to upload a file to Object Storage Service (OSS).', 'type' => 'string', 'example' => '2skeuurfj****', 'title' => ''], 'AccessKeySecret' => ['description' => 'The AccessKey secret that is used to authorize a user to upload a file to OSS.', 'type' => 'string', 'example' => 'skdkdukeuuuu****', 'title' => ''], 'EndPoint' => ['description' => 'The address of the OSS server to which a file is uploaded.', 'type' => 'string', 'example' => 'https://oss.com', 'title' => ''], 'Dir' => ['description' => 'The directory to which the file is uploaded in Object Storage Service (OSS).', 'type' => 'string', 'example' => '100010****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The HTTP status code returned.'."\n" ."\n" .'- A value of OK indicates that the call is successful.'."\n" ."\n" .'- Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetChatappUploadAuthorization', 'description' => 'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:12.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:29:58.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappUploadAuthorization'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappUploadAuthorization', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetChatappVerifyCode' => [ '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.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the Independent Software Vendor (ISV) sub-customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-kei****', 'title' => ''], ], [ 'name' => 'Method', 'in' => 'query', 'schema' => [ 'description' => 'The method to receive the verification code.', 'enumValueTitles' => ['voice' => 'Receive by phone call.', 'sms' => 'Receive by text message.'], 'type' => 'string', 'required' => true, 'example' => 'sms', 'title' => '', ], ], [ 'name' => 'Locale', 'in' => 'query', 'schema' => ['description' => 'The language. For values, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'zh_CN', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B', 'title' => ''], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- A value of OK indicates that the request is successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call is successful.'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetChatappVerifyCode', 'summary' => 'Requests a verification code to be sent to the specified phone number.', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [ ['createdAt' => '2023-07-04T11:29:58.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappVerifyCode'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappVerifyCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], '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.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '1380000****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Access denied for detailed information.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'CartEnable' => ['description' => 'Indicates whether the shopping cart button is displayed. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'CatalogVisible' => ['description' => 'Indicates whether the catalog button is displayed. Valid values:'."\n" ."\n" .'- true'."\n" ."\n" .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- The value OK indicates that the request was successful.'."\n" ."\n" .'- Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetCommerceSetting', 'description' => 'This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommerceSetting'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:GetCommerceSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetConversationalAutomation' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID.', 'type' => 'string', 'required' => true, 'example' => 'cams-3ie***', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number of the enterprise.', 'type' => 'string', 'required' => true, 'example' => '86130000***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Prompts' => [ 'description' => 'The opening remarks.', 'type' => 'array', 'items' => ['description' => 'The opening remark.', 'type' => 'string', 'example' => 'prompt1', 'title' => ''], 'example' => '', 'title' => '', ], 'Commands' => [ 'description' => 'The commands.', 'type' => 'array', 'items' => [ 'description' => 'The command.', 'type' => 'object', 'properties' => [ 'CommandDescription' => ['description' => 'The description of the command.', 'type' => 'string', 'example' => 'description', 'title' => ''], 'CommandName' => ['description' => 'The name of the command.', 'type' => 'string', 'example' => 'common1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'PhoneNumber' => ['description' => 'The phone number of the enterprise.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'EnableWelcomeMessage' => ['description' => 'Indicates whether the welcoming message is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- The value OK indicates that the request was successful.'."\n" ."\n" .'- For more information about other response codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Get number welcome messages, opening remarks, and commands', 'summary' => 'Queries the conversational automation settings for a phone number.', 'description' => '### [](#qps-)QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.'."\n" ."\n" .'This operation retrieves data directly from Meta. Meta imposes its own rate limits on the total number of calls. Stay within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationalAutomation'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetConversationalAutomation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '228871', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetCustomerSite' => [ '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' => 'The details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request. The ID is a unique identifier that Alibaba Cloud generates for the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '3R938***', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The returned data object.', 'type' => 'string', 'example' => 'cn', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query customer source site', 'summary' => 'Queries the source site of a customer.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetCustomerSite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"RequestId\\": \\"3R938***\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"cn\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'GetDownloadExcelList' => [ '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' => 'Condition', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'aa', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '39***', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '{}', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '200', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetDownloadExcelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"39***\\",\\n \\"Data\\": \\"{}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetFbInstagramPages' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'ftete3254***', 'default' => '', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'inst-8t47hh***5pyj0ps', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'ok', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'hgfh77-gfh55***', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['type' => 'string', 'example' => '12534653543', 'description' => '', 'title' => ''], 'AccountId' => ['type' => 'string', 'example' => '1245454654654', 'description' => '', 'title' => ''], 'PageName' => ['type' => 'string', 'example' => 'iwhalecloud', 'description' => '', 'title' => ''], 'ConnectionStatus' => ['type' => 'string', 'example' => 'Connected', 'description' => '', 'title' => ''], 'AccountName' => ['type' => 'string', 'example' => 'Alice', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFbInstagramPages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetFbMessengerPages' => [ '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' => 'AccessToken', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'EARDGFDGF12****', 'description' => '', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => 'inst-8t47hh***5pyj0ps', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'ok', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'sd2dsd-33*****', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['type' => 'string', 'example' => '17433243434', 'description' => '', 'title' => ''], 'PageName' => ['type' => 'string', 'example' => 'iwhalecloud-2', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFbMessengerPages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetFlow' => [ 'summary' => 'Queries the details of a WhatsApp flow, including its status, name, categories, and preview URL.', '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' => 'formData', 'schema' => ['description' => 'The flow ID. This is the FlowId returned when you call [CreateFlow](~~2638742~~) to create a WhatsApp flow.', 'type' => 'string', 'required' => true, 'example' => '333993838***'."\n", 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575'."\n"], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status of the flow.', 'enumValueTitles' => ['PUBLISHED' => '', 'DRAFT' => '', 'DEPRECATED' => ''], 'type' => 'string', 'example' => 'DRAFT', 'title' => '', ], 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '92675332812643****', 'title' => ''], 'PreviewUrl' => ['description' => 'The temporary preview URL.', 'type' => 'string', 'example' => 'https://pre-url', 'title' => ''], 'EndpointUri' => ['type' => 'string', 'example' => 'http://abc.com', 'description' => '', 'title' => ''], 'JSONVersion' => ['description' => 'The JSON version.', 'type' => 'string', 'example' => '2.1', 'title' => ''], 'Categories' => [ 'description' => 'The list of categories.', 'type' => 'array', 'items' => ['description' => 'The category.', 'type' => 'string', 'example' => 'SIGN_UP', 'title' => ''], 'example' => '', 'title' => '', ], 'FlowName' => ['description' => 'The flow name.', 'type' => 'string', 'example' => 'flow_001', 'title' => ''], 'DataApiVersion' => ['description' => 'The API version.', 'type' => 'string', 'example' => '3.0', 'title' => ''], 'PreviewUrlExpires' => ['description' => 'The expiration time of the preview URL.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700617436633'."\n", 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\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' => '- Before calling this operation, make sure that you have created a WhatsApp flow.'."\n" ."\n" .'- If you have not created a WhatsApp flow, call the [CreateFlow](~~2638742~~) API to create one.'."\n" ."\n" .'#### QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled and may result in service interruptions.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetFlowJSONAssest' => [ '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' => 'formData', 'schema' => ['description' => 'The ID of the flow. This ID is returned when you call the [CreateFlow](~~2638742~~) API.', 'type' => 'string', 'required' => true, 'example' => '17b6****************************', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. View the space ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '92675332812643****', 'title' => ''], 'FilePath' => ['description' => 'The file path.', 'type' => 'string', 'example' => 'https://bucket-*****-ap-southeast-1.aliyuncs.com/9658820125168****.json', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetFlowJSONAssest', 'summary' => 'Queries the JSON content of a WhatsApp flow.', 'description' => '- Before calling this operation, make sure that you have created a WhatsApp flow.'."\n" ."\n" .'- If you have not created a WhatsApp flow, call the [CreateFlow](~~2638742~~) API to create one.'."\n" ."\n" .'#### QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled and may result in service interruptions.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowJSONAssest'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlowJSONAssest', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetFlowPreviewUrl' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '200995', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'formData', 'schema' => ['description' => 'The flow ID. This is the FlowId returned by the [CreateFlow](~~2638742~~) operation when you create a WhatsApp flow.', 'type' => 'string', 'required' => true, 'example' => '333993838***'."\n", 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The Space ID of an ISV sub-customer or the instance ID of a direct customer. View the Space ID on the [Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '92675332812643****', 'title' => ''], 'PreviewUrl' => ['description' => 'The temporary preview URL.', 'type' => 'string', 'example' => 'https://business.facebook.com/****', 'title' => ''], 'PreviewUrlExpires' => ['description' => 'The expiration time of the preview URL.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700617436633', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetFlowPreviewUrl', 'summary' => 'Generates a temporary preview URL for a WhatsApp flow.', 'description' => '- After you create a WhatsApp flow, call this operation to generate a temporary preview URL for the flow.'."\n" ."\n" .'- Before you call this operation, make sure that you have created a WhatsApp flow.'."\n" ."\n" .'- If you do not have a WhatsApp flow, you can call the [CreateFlow](~~2638742~~) API to create one.'."\n" ."\n" .'#### QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled and may result in service interruptions.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowPreviewUrl'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlowPreviewUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetGroupExist' => [ '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' => ['type' => 'string', 'required' => true, 'example' => 'aaa', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => 'False', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetGroupExist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetMessageCampaignInsights' => [ 'summary' => 'Retrieves campaign metrics.', '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' => 'The Space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of the direct customers. This is the channel ID. You can find the channel ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-x**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID.', 'type' => 'string', 'required' => true, 'example' => '323**', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'required' => true, 'example' => '23***', 'title' => ''], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The ID of the campaign.', 'type' => 'string', 'required' => true, 'example' => '23**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 's39**', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'MarketingMessagesLinkBtnClick' => ['description' => 'The number of times users click or tap a marketing message that take users to an on-Meta or off-Meta destination, as specified by the advertiser. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.', 'type' => 'string', 'example' => '268', 'title' => ''], 'MarketingMessagesSpend' => ['description' => 'The total amount spent on a campaign, message group, or message during over its lifetime.', 'type' => 'string', 'example' => '38.87', 'title' => ''], 'MarketingMessagesDelivered' => ['description' => 'The number of messages that are sent by the business and successfully delivered to users. Some messages may fail to deliver if a user\'s device is unavailable. This metric excludes messages delivered to Europe and Japan. In some cases, this metric is an estimate. The value may differ from the data on your bill due to minor discrepancies during data processing.', 'type' => 'string', 'example' => '2755', 'title' => ''], 'DateStop' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2025-07-29', 'title' => ''], 'MarketingMessagesReadRate' => ['description' => 'The number of read messages divided by the number of delivered messages. The read status of some messages may not be captured if a customer disables read receipts. This metric excludes messages sent to Europe and Japan.', 'type' => 'string', 'example' => '79.419238', 'title' => ''], 'MarketingMessagesCostPerDelivered' => ['description' => 'The average cost per delivered message.', 'type' => 'string', 'example' => '2755', 'title' => ''], 'DateStart' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2025-07-01', 'title' => ''], 'MarketingMessagesDeliveryRate' => ['description' => 'The message delivery rate.', 'type' => 'string', 'example' => '79.419238', 'title' => ''], 'MarketingMessagesLinkBtnClickRate' => ['description' => 'The percentage of delivered messages that received a link click. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.', 'type' => 'string', 'example' => '79.419238', 'title' => ''], 'MarketingMessagesCostPerLinkBtnClick' => ['description' => 'The average cost per message link click. This metric excludes messages sent to Europe, Argentina, Türkiye, South Korea, and Japan.', 'type' => 'string', 'example' => '268', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The returned data.', 'title' => '', ], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: successful.'."\n" ."\n" .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetMessageCampaignInsights', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetMessageCampaignInsights', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetMigrationVerifyCode' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '164326', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'Locale', 'in' => 'query', 'schema' => ['description' => 'The language.', 'type' => 'string', 'required' => true, 'example' => 'zh_CN', 'title' => ''], ], [ 'name' => 'Method', 'in' => 'query', 'schema' => [ 'description' => 'The verification code delivery method.', 'enumValueTitles' => ['voice' => 'received via phone call.', 'sms' => 'received via SMS.'], 'type' => 'string', 'required' => true, 'example' => 'sms', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'Id' => ['description' => 'The phone number ID.', 'type' => 'string', 'example' => '8282889****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Retrieve verification code for migration phone number', 'summary' => 'Retrieves the verification code for a migration phone number.', 'description' => 'The China Message Service API has a single-user QPS limit of 10 calls per second. If this limit is exceeded, throttling is triggered, which may affect your business. Adjust your call frequency accordingly.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:11.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:30:04.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMigrationVerifyCode'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetMigrationVerifyCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetPermissionByCode' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '201033', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], ], 'parameters' => [ [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'required' => true, 'example' => 'flow_001', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-isj23ljd912', 'title' => ''], ], [ 'name' => 'Permissions', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The permissions.', 'type' => 'array', 'items' => ['description' => 'The permissions.', 'type' => 'string', 'required' => false, 'example' => 'whatsapp_business_messaging', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'No', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain authorization permissions by using the embedded code', 'summary' => 'Obtains authorization permissions by using the code obtained from the embedded integration.', 'description' => 'The China Message Service API has a single-user QPS limit of 5 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable frequency.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermissionByCode'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPermissionByCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"No\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'GetPhoneEncryptionPublicKey' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201018', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. You can view it on the'."\n" .'[**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)> **Manage** > **WABA Management** > **Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86189********', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)'."\n" .'page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'EncryptionPublicKey' => ['description' => 'The public key.', 'type' => 'string', 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\/swzTMEopLORQV28uqN\\/2\\/x9hjU\\****\\/Zwa\\/Vk5Svp4\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\nkwIDAQAB\\n-----END PUBLIC KEY-----"', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861526377****', 'title' => ''], 'EncryptionPublicKeyStatus' => [ 'description' => 'The validity status of the public key. Valid values:'."\n" ."\n" .'- MISMATCH: invalid.'."\n" ."\n" .'- VALID: valid.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'VALID', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Retrieve the encryption public key of a phone number', 'summary' => 'Retrieves the encryption public key of a phone number.', 'description' => '- Before calling this operation, make sure that a phone number has been added under your WABA and has passed phone number verification.'."\n" ."\n" .'- If no phone number has been added under your WABA, call the [GetChatappVerifyCode](~~600746~~) and [ChatappVerifyAndRegister](~~600770~~) operations to obtain a verification code and register the phone number.'."\n" ."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPhoneEncryptionPublicKey'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPhoneEncryptionPublicKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetPhoneNumberVerificationStatus' => [ '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' => 'formData', 'schema' => ['description' => 'The phone number. You can view the phone number on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **WABA Management** > **Phone Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86138009****'."\n", 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The Space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of the direct customer. You can view the Space ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2D', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'CodeVerificationStatus' => [ 'description' => 'The verification status.', 'enumValueTitles' => ['REVOKED' => 'The verification request was revoked.', 'MORE_INFORMATION_REQUESTED' => 'More information is required.', 'VERIFIED' => 'The phone number is verified.', 'REJECTED' => 'The verification was rejected.'], 'type' => 'string', 'example' => 'VERIFIED', 'title' => '', ], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861390000****', 'title' => ''], 'Id' => ['description' => 'The ID of the phone number.', 'type' => 'string', 'example' => '222434****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => 'The response parameters.', 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetPhoneNumberVerificationStatus', 'summary' => 'Retrieves the verification status of a phone number.', 'description' => '- You can call this operation to retrieve the verification status of a phone number. You can also view the status on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **WABA Management** > **Phone Number Management** page.'."\n" ."\n" .'- Before calling this operation, add a phone number to your WhatsApp Business Account (WABA) and submit it for verification.'."\n" ."\n" .'- If you have not added a phone number to your WABA, call the [GetChatappVerifyCode](~~600746~~) and [ChatappVerifyAndRegister](~~600770~~) APIs to obtain a verification code and register the number.'."\n" ."\n" .'This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:11.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPhoneNumberVerificationStatus'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPhoneNumberVerificationStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\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"}]', 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetPledgeTemplateAddress' => [ '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' => 'The industry type.', 'type' => 'string', 'required' => false, 'example' => 'it', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) interface.', 'type' => 'string', 'required' => false, 'example' => 'cams-x***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'example' => 'https://******', 'title' => ''], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Download URL for letter of guarantee template', 'summary' => 'Retrieves the download URL for the letter of guarantee template.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPledgeTemplateAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'GetPreValidatePhoneId' => [ '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' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '86138****', 'title' => ''], ], [ 'name' => 'VerifyCode', 'in' => 'formData', 'schema' => ['description' => 'The verification code provided when you purchased the pre-validated phone number.', 'type' => 'string', 'required' => true, 'example' => '2083**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](https://www.alibabacloud.com/help/en/cams/latest/api-error-codes).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PhoneNumberId' => ['description' => 'The phone number ID.', 'type' => 'string', 'title' => '', 'example' => '861380000****'], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'title' => '', 'example' => '92****'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'GetPreValidatePhoneId', 'summary' => 'Gets the ID for a pre-validated phone number. Use this ID to select the number in the Embedded Signup flow without obtaining a new verification code.', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPreValidatePhoneId'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPreValidatePhoneId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'GetViberByRequestNo' => [ 'summary' => 'Retrieves the application by its 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' => 'The request ID.', 'type' => 'string', 'required' => true, 'example' => '86512358****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of an ISV sub-customer or the Instance ID of a direct customer.', 'type' => 'string', 'required' => false, 'example' => '28251486512358****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Access denial details.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The unique ID for the request. You can use this Aliyun-generated ID for troubleshooting.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8**9-A94866411B2O'."\n", 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'AuditResult' => ['description' => 'The audit result.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Creator' => ['description' => 'The creator of the resource.', 'type' => 'string', 'example' => '11', 'title' => ''], 'Reason' => ['description' => 'The audit comment.', 'type' => 'string', 'example' => 'aa', 'title' => ''], 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '1753236426000', 'title' => ''], 'SubscriberCode' => ['description' => 'The subscriber code.', 'type' => 'string', 'example' => '4534**', 'title' => ''], 'MaapServiceNo' => ['description' => 'The Viber service ID.', 'type' => 'string', 'example' => '735221', 'title' => ''], 'State' => ['description' => 'The status of the request.', 'type' => 'string', 'example' => 'A', 'title' => ''], 'AuditTime' => ['description' => 'The audit time.', 'type' => 'string', 'example' => '1785465', 'title' => ''], 'GmtModifier' => ['description' => 'The modification time.', 'type' => 'string', 'example' => '17833636', 'title' => ''], 'Id' => ['description' => 'The ID of the resource.', 'type' => 'string', 'example' => '11', 'title' => ''], 'AuditRecord' => [ 'type' => 'object', 'properties' => [ 'ContactMail' => ['description' => 'The contact email address.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'CompanyLegalName' => ['description' => 'The legal name of the company.', 'type' => 'string', 'example' => 'xxxxxxcompany', 'title' => ''], 'LetterGuarantee' => ['description' => 'The URL of the letter of guarantee.', 'type' => 'string', 'example' => 'https://xxxxxxxxxx', 'title' => ''], 'IndustryInvolved' => ['description' => 'The company\'s industry.', 'type' => 'string', 'example' => 'cateringServices', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'type' => 'array', 'items' => ['description' => 'An international destination country or region.', 'type' => 'string', 'example' => '["355|AL"]', 'title' => ''], 'example' => '', 'description' => 'The international destination countries or regions.', 'title' => '', ], 'CompleteAddressOfHeadquarters' => ['description' => 'The complete address of the company\'s headquarters.', 'type' => 'string', 'example' => 'address', 'title' => ''], 'MessageEnableDate' => ['description' => 'The date business messaging is enabled.', 'type' => 'string', 'example' => '2025-08-05', 'title' => ''], 'BusinessLicenseRegistrationNumber' => ['description' => 'The business license registration number.', 'type' => 'string', 'example' => '43645465465', 'title' => ''], 'CompanyLegalPerson' => ['description' => 'The name of the company\'s legal representative.', 'type' => 'string', 'example' => 'jack', 'title' => ''], 'CompanyAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyAddress' => ['description' => 'The company address.', 'type' => 'string', 'example' => 'address', 'title' => ''], 'CompanyAddressTitle' => ['description' => 'The title of the company address.', 'type' => 'string', 'example' => '111', 'title' => ''], ], 'description' => 'Details for a single company address.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The company addresses.', 'title' => '', ], 'CompanyRegisteredCountry' => ['description' => 'The country or region where the company is registered.', 'type' => 'string', 'example' => 'beijing', 'title' => ''], 'AgeLimit' => ['description' => 'The age restriction.', 'type' => 'string', 'example' => 'eighteenUp', 'title' => ''], 'IndustryDescription' => ['description' => 'A description of the industry.', 'type' => 'string', 'example' => 'Description', 'title' => ''], 'WebAddress' => ['description' => 'The company website.', 'type' => 'string', 'example' => 'https://xxxxxx', 'title' => ''], 'EnableAutoReply' => ['description' => 'Indicates whether auto-reply is enabled.', 'type' => 'string', 'example' => 'N', 'title' => ''], 'NowRecovery' => ['description' => 'The recovery status.', 'type' => 'string', 'example' => 'NowRecovery', 'title' => ''], 'RecoveryDate' => ['description' => 'The date of recovery.', 'type' => 'string', 'example' => '2025-11-11', 'title' => ''], 'BusinessAccountName' => ['description' => 'The name of the business account.', 'type' => 'string', 'example' => 'aaaa', 'title' => ''], 'ApplyReason' => ['description' => 'The reason for the application.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'Logo' => [ 'type' => 'array', 'items' => ['description' => 'A logo URL.', 'type' => 'string', 'example' => '["http://xxx","http://xxxx"]', 'title' => ''], 'example' => '', 'description' => 'The logo URLs.', 'title' => '', ], 'ReplyContent' => ['description' => 'The content of the auto-reply message.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'CompanyProfile' => ['description' => 'The company profile.', 'type' => 'string', 'example' => 'new', 'title' => ''], 'CompanyTel' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyTelNumber' => ['description' => 'The company telephone number.', 'type' => 'string', 'example' => '134213213', 'title' => ''], 'CompanyTelTitle' => ['description' => 'The title for the telephone number.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'description' => 'Details for a single telephone number.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The company telephone numbers.', 'title' => '', ], 'OtherLetterGuarantee' => ['description' => 'The URL for supplementary information.', 'type' => 'string', 'example' => 'https://wwwxxxx', 'title' => ''], 'MessageDialogueIntroduction' => ['description' => 'A brief introduction to the business messaging conversation.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'MessageDestinationCountry' => [ 'type' => 'array', 'items' => ['description' => 'A local destination country or region.', 'type' => 'string', 'example' => '["61|es"]', 'title' => ''], 'example' => '', 'description' => 'The local destination countries or regions.', 'title' => '', ], 'SuspensionDate' => ['description' => 'The suspension date.', 'type' => 'string', 'example' => 'SuspensionDate', 'title' => ''], 'MessageSessionName' => ['description' => 'The name of the business messaging conversation.', 'type' => 'string', 'example' => 'name', 'title' => ''], 'CompanyEnglishName' => ['description' => 'The English name of the company.', 'type' => 'string', 'example' => 'english', 'title' => ''], 'ContactPhone' => ['description' => 'The contact person\'s phone number.', 'type' => 'string', 'example' => '861151515***', 'title' => ''], 'ContactPosition' => ['description' => 'The contact person\'s position.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'ContactEmail' => ['description' => 'The contact person\'s email address.', 'type' => 'string', 'example' => '6944**@gmail.com', 'title' => ''], 'ContactName' => ['description' => 'The contact person\'s name.', 'type' => 'string', 'example' => 'qwq', 'title' => ''], ], 'example' => '', 'description' => 'The audit record details.', 'title' => '', ], 'Modifier' => ['description' => 'The user who last modified the resource.', 'type' => 'string', 'example' => '11', 'title' => ''], 'RequestNo' => ['description' => 'The unique number for the application request.', 'type' => 'string', 'example' => '5435435435', 'title' => ''], 'RequestType' => ['description' => 'The type of the request.', 'type' => 'string', 'example' => 'viberOpen', 'title' => ''], ], 'description' => 'The response data.', 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- `OK`: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates if the request was successful. Valid values:'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetViberByRequestNo', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetViberByRequestNo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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\\": \\"example\\",\\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 \\"ContactPhone\\": \\"861151515***\\",\\n \\"ContactPosition\\": \\"example\\",\\n \\"ContactEmail\\": \\"6944**@gmail.com\\",\\n \\"ContactName\\": \\"qwq\\"\\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' => ['type' => 'string', 'required' => true, 'example' => 'cams-x***', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '90E63D28-E31D-1EB2**9-A94866411B2O'."\n", 'description' => '', 'title' => ''], 'Data' => ['type' => 'object', 'description' => '', 'example' => '11', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetViberPauseTimes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetWhatsappConnectionCatalog' => [ '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.', 'type' => 'string', 'required' => true, 'example' => '29293939****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the user within the ISV account.', 'type' => 'string', 'required' => false, 'example' => 'C20209399229****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Model' => ['description' => 'The returned data.', 'type' => 'object', 'example' => '{"id":"200292992","name":"Alibaba_catalog"}', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- The value OK indicates that the request was successful.'."\n" ."\n" .'- Other values indicate that the request failed. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'GetWhatsappConnectionCatalog', 'summary' => 'Queries the product catalogs that are associated with a WhatsApp Business account (WABA).', 'description' => 'This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWhatsappConnectionCatalog'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappConnectionCatalog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetWhatsappConversionApi' => [ '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' => 'InstanceId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'chatbot-cn-VBe6QXXX', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['type' => 'string', 'example' => '7832312', 'description' => '', 'title' => ''], 'PageName' => ['type' => 'string', 'example' => 'aaa', 'description' => '', 'title' => ''], 'DatasetId' => ['type' => 'string', 'example' => '111', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'GetWhatsappHealthStatus' => [ '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" ."\n" .'- phone: phone number'."\n" ."\n" .'- waba: WhatsApp Business Account (WABA)', 'enumValueTitles' => ['template' => 'template', 'phone' => 'phone', 'waba' => 'waba'], 'type' => 'string', 'required' => true, 'example' => 'waba', 'title' => '', ], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number of the enterprise.', 'type' => 'string', 'required' => false, 'example' => '86138***', 'title' => ''], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['description' => 'The template code.', 'type' => 'string', 'required' => false, 'example' => '399299***', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The template language.', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['description' => 'WabaId', 'type' => 'string', 'required' => false, 'example' => '299399****', 'title' => ''], ], [ '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.', 'type' => 'string', 'required' => true, 'example' => '2993****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'CanSendMessage' => ['description' => 'Indicates whether the messages can be sent.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''], 'Entities' => [ 'description' => 'The queried entities.', 'type' => 'array', 'items' => [ 'description' => 'The queried entity.', 'type' => 'object', 'properties' => [ 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'PHONE_NUMBER', 'title' => ''], 'TemplateCode' => ['description' => 'The template code. This parameter is returned when the NodeType parameter is set to **template**.', 'type' => 'string', 'example' => '939928****', 'title' => ''], 'Errors' => [ 'description' => 'The reasons why the messages failed to be sent.', 'type' => 'array', 'items' => [ 'description' => 'The reason why the messages failed to be sent.', 'type' => 'object', 'properties' => [ 'ErrorDescription' => ['description' => 'The description of the error.', 'type' => 'string', 'example' => 'There is an error with the payment method.', 'title' => ''], 'PossibleSolution' => ['description' => 'The possible solution to the error.', 'type' => 'string', 'example' => 'There was an error with your payment method. Please add a new payment method to the account.', 'title' => ''], 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '141006', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Language' => ['description' => 'The template language.', 'type' => 'string', 'example' => 'en', 'title' => ''], 'CanSendMessage' => ['description' => 'Indicates whether the messages can be sent.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number to which the messages are sent.', 'type' => 'string', 'example' => '86138****', 'title' => ''], 'WabaId' => ['description' => 'The WABA ID. You can view the WABA ID in the Chat App Message Service console after you create the WABA.', 'type' => 'string', 'example' => '39939***', 'title' => ''], 'BusinessId' => ['description' => 'The Business Manager ID.', 'type' => 'string', 'example' => '3992****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- The value OK indicates that the request was successful.'."\n" ."\n" .'- For more information about other response codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'title' => 'Get Whatsapp message send health status', 'summary' => 'Queries the messaging health status of different types of nodes.', 'description' => '### [](#qps-)QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.'."\n" ."\n" .'This operation retrieves data directly from Meta. Meta imposes its own rate limits on the total number of calls. Stay within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWhatsappHealthStatus'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappHealthStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'IsvGetAppId' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '161013', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], ], 'parameters' => [ [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- whatsapp: WhatsApp.', 'type' => 'string', 'required' => true, 'example' => 'whatsapp', 'title' => ''], ], [ 'name' => 'IntlVersion', 'in' => 'query', 'schema' => ['description' => 'The version.', 'type' => 'string', 'required' => false, 'example' => '2', 'default' => '2', 'title' => ''], ], [ 'name' => 'Permissions', 'in' => 'query', 'schema' => ['description' => 'The permissions.', 'type' => 'string', 'required' => false, 'example' => 'Example value', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '744c4b5c79c9432497a075bdfca3***', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'AppId' => ['description' => 'The App ID.', 'type' => 'string', 'example' => '23hr3v****', 'title' => ''], 'ConfigId' => ['description' => 'The configuration item ID.', 'type' => 'string', 'example' => '28972951817****', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve app ID', 'summary' => 'Retrieves the App ID for an ISV.', 'description' => 'The QPS limit for a single user of this API is 10 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this API at a reasonable frequency.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:30:09.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-29T01:41:05.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsvGetAppId'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:IsvGetAppId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"744c4b5c79c9432497a075bdfca3***\\",\\n \\"Message\\": \\"null\\",\\n \\"AppId\\": \\"23hr3v****\\",\\n \\"ConfigId\\": \\"28972951817****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'ListAllGroups' => [ 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '608F9CCA-B5EB-3D72-XXXXB25D6D75BDEC'."\n", 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'GroupName' => ['type' => 'string', 'example' => 'aaa', 'description' => '', 'title' => ''], 'GmtCreate' => ['type' => 'string', 'example' => '1789000', 'description' => '', 'title' => ''], 'Id' => ['type' => 'string', 'example' => '5435', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListAllGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListBindDmAccount' => [ 'summary' => '', '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' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'xxx-xx**', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => ['type' => 'string', 'example' => 'ins', 'description' => '', 'title' => ''], 'InstanceId' => ['type' => 'string', 'example' => 'cams-*', 'description' => '', 'title' => ''], 'AccountCode' => ['type' => 'string', 'example' => 'xx@xx.com', 'description' => '', 'title' => ''], 'ExtendAttr' => [ 'type' => 'object', 'properties' => [ 'SendType' => ['type' => 'string', 'example' => 'batch', 'description' => '', 'title' => ''], 'AccountName' => ['type' => 'string', 'example' => 'xx@xx.com', 'description' => '', 'title' => ''], ], 'example' => '', 'description' => '', 'title' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListBindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"xxx-xx**\\",\\n \\"Data\\": [\\n {\\n \\"InstanceName\\": \\"ins\\",\\n \\"InstanceId\\": \\"cams-*\\",\\n \\"AccountCode\\": \\"xx@xx.com\\",\\n \\"ExtendAttr\\": {\\n \\"SendType\\": \\"batch\\",\\n \\"AccountName\\": \\"xx@xx.com\\"\\n }\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'ListBindingRelationsForFlowVersion' => [ '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' => 'The flow code. You can view the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => [ 'description' => 'The channel type. Valid values:'."\n" ."\n" .'- INSTAGRAM'."\n" ."\n" .'- WHATSAPP'."\n" ."\n" .'- MESSENGER'."\n" ."\n" .''."\n" ."\n" .'- VIBER'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'title' => '', 'example' => 'WHATSAPP', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Data' => [ 'description' => 'The list of returned data.', 'type' => 'array', 'items' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Query List of Bound Phone Numbers or Merchant Account IDs', 'summary' => 'Queries the phone numbers or business account IDs attached to a flow.', 'description' => '- You can call this operation to query the phone numbers or business account IDs attached to a flow. You can also view this information on the **Settings** page in the **Flow Editor**.'."\n" ."\n" .'- Before you call this operation, ensure that a phone number or business account ID is attached to your flow.'."\n" ."\n" .'- If a phone number or business account ID is not attached to your flow, you can attach one manually on the **Settings** page in the **Flow Editor** or by calling the [FlowBindPhone](~~2937190~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ListBindingRelationsForFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListChatFlow' => [ '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' => 'The flow status. Default value: NORMAL.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'FlowTriggerType', 'in' => 'query', 'schema' => [ 'description' => 'The flow trigger type. Valid values:'."\n" .'- TriggeredManually'."\n" .'- TriggeredByWhatsApp'."\n" .'- TriggeredByInstagram'."\n" .'- TriggeredByViber'."\n" .'- TriggeredByMessenger', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'TriggeredByWhatsApp', 'title' => '', ], ], [ 'name' => 'ReturnWithOnlineVersion', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to return the online status. Valid values:'."\n" ."\n" .'- true: Yes.'."\n" ."\n" .'- false: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'false', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. This parameter is used for fuzzy match of flow names.', 'type' => 'string', 'required' => false, 'example' => 'LLM', 'title' => ''], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'ALICOM_OPAAS', 'default' => 'ALICOM_OPAAS', 'title' => '', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: an empty collection.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List flows', 'summary' => 'Lists flows.', 'description' => '- You can call this operation to query flows, or manually query flows in the [Flow Builder](https://chatapp.console.aliyun.com/ChatFlowBuilder) console.'."\n" ."\n" .'- Before calling this operation, make sure that you have successfully created flows.'."\n" ."\n" .'- If you do not have any successfully created flows, manually create a flow in the [Flow Builder](https://chatapp.console.aliyun.com/ChatFlowBuilder) console or call the [CreateChatFlow](~~2937204~~) operation to create a flow.'."\n" ."\n" .'- The optional parameters in this operation are filter conditions for querying flows. If you do not specify these parameters, all flows are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListChatFlowTemplate' => [ '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' => 'The trigger type of the flow. Valid values:'."\n" ."\n" .'- TriggeredManually'."\n" ."\n" .'- TriggeredByWhatsApp'."\n" ."\n" .'- TriggeredByInstagram'."\n" ."\n" .'- TriggeredByViber'."\n" ."\n" .'- TriggeredByMessenger', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['TriggeredManually' => 'TriggeredManually', 'TriggeredByWhatsApp' => 'TriggeredByWhatsApp', 'TriggeredByMessenger' => 'TriggeredByMessenger', 'TriggeredByInstagram' => 'TriggeredByInstagram', 'TriggeredByViber' => 'TriggeredByViber'], 'title' => '', 'example' => 'TriggeredByWhatsApp', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The keyword for the search. The operation performs a fuzzy query for template names based on this keyword.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'LLM'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '10'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. Default value: ALICOM\\_OPAAS.', 'type' => 'string', 'required' => true, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'List Flow Templates', 'summary' => 'Lists flow templates.', 'description' => '- You can call this operation to list flow templates. You can also view the list of templates on the **View Templates** page in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- You can use the optional parameters in this operation to filter the list of templates. If you do not specify any filter conditions, all templates are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ListChatFlowTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListChatGroup' => [ 'summary' => 'Retrieves the list of IM groups.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcams1BZAO7'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'BusinessNumber', 'in' => 'query', 'schema' => ['description' => 'The business phone number.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values: **WHATSAPP**.'."\n" ."\n" .'> Only the WhatsApp channel type is supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-x***', 'title' => ''], ], [ 'name' => 'GroupStatus', 'in' => 'query', 'schema' => ['description' => 'The group status. Valid values:'."\n" ."\n" .'- ACTIVE: In use.'."\n" ."\n" .'- INACTIVE: Not activated.'."\n" ."\n" .'- SUSPENDED: Suspended.'."\n" ."\n" .'- CREATING: Being created.'."\n" ."\n" .'- DELETING: Being deleted.'."\n" ."\n" .'- UPDATING: Being updated.', 'type' => 'string', 'required' => false, 'example' => 'ACTIVE', 'title' => ''], ], [ 'name' => 'Subject', 'in' => 'query', 'schema' => ['description' => 'The group subject.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'GroupType', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Telegram group type.', 'type' => 'string', 'required' => false, 'example' => 'example'], ], [ 'name' => 'GroupLink', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The Telegram group link.', 'type' => 'string', 'required' => false, 'example' => 'example'], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => true, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The prompt message. This parameter has a value when an exception is returned.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '51', 'title' => ''], 'List' => [ 'description' => 'The group list.', 'type' => 'array', 'items' => [ 'description' => 'The group object.', 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'BusinessNumber' => ['description' => 'The business phone number.', 'type' => 'string', 'example' => '8613800**', 'title' => ''], 'InviteLink' => ['description' => 'The invite link.', 'type' => 'string', 'example' => 'https://chat.whatsapp.com/***', 'title' => ''], 'GroupStatus' => ['description' => 'The group status.', 'type' => 'string', 'example' => 'ACTIVE', 'title' => ''], 'ProfilePictureFile' => ['description' => 'The group profile picture.', 'type' => 'string', 'example' => 'https://*********/png.jpg', 'title' => ''], 'Subject' => ['description' => 'The group subject.', 'type' => 'string', 'example' => 'This is a test subject', 'title' => ''], 'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'EA30d***', 'title' => ''], 'GroupLink' => ['title' => '', 'description' => 'The group link.', 'type' => 'string', 'example' => 'example'], 'TotalParticipantCount' => ['title' => '', 'description' => 'The number of group members.', 'type' => 'integer', 'format' => 'int64', 'example' => '35'], 'GroupType' => ['title' => '', 'description' => 'The group type.', 'type' => 'string', 'example' => 'example'], 'BusinessRole' => ['title' => '', 'description' => 'The role of the bot in the group.', 'type' => 'string', 'example' => 'example'], 'GmtModifier' => ['title' => '', 'description' => 'The update time.', 'type' => 'integer', 'format' => 'int64', 'example' => '94'], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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 \\"GroupLink\\": \\"example\\",\\n \\"TotalParticipantCount\\": 35,\\n \\"GroupType\\": \\"example\\",\\n \\"BusinessRole\\": \\"example\\",\\n \\"GmtModifier\\": 94\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'List IM groups', 'description' => '>The feature of retrieving IM group lists through API is a Meta beta feature. Contact your account manager to apply for access.>'."\n" ."\n" .'- Before calling this operation, make sure you have successfully created IM groups.'."\n" ."\n" .'- If you do not have any created IM groups, you can only create IM groups through the [AddChatGroup](~~2998429~~) operation.'."\n" ."\n" .'- The optional parameters of this operation are filter conditions for the IM group list. If you do not specify them, all IM groups are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListChatGroupParticipants' => [ 'summary' => 'Lists the members of an IM group.', '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' => 'The business number. You can call the [ListChatGroup](~~2932629~~) operation to obtain the business number.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid value:'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'> This operation supports only the WhatsApp channel.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID. You can call the [ListChatGroup](~~2932629~~) operation to obtain the group ID.', 'type' => 'string', 'required' => true, 'example' => 'EA939****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'This is the instance ID for direct customers or the SpaceId for ISV sub-customers. You can find the ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-k***', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The paging information.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'Total' => ['description' => 'The total number of participants.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], 'List' => [ 'description' => 'The list of group members.', 'type' => 'array', 'items' => [ 'description' => 'Information about a group member.', 'type' => 'object', 'properties' => [ 'ParticipantNumber' => ['description' => 'The phone number of the group member.', 'type' => 'string', 'example' => '861382***', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other values, see the [error code list](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Total\\": 8,\\n \\"List\\": [\\n {\\n \\"ParticipantNumber\\": \\"861382***\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'ListChatGroupParticipants', 'description' => '>'."\n" ."\n" .'This operation is an internal preview feature. Contact your account manager to request access.'."\n" ."\n" .'>'."\n" ."\n" .'- Before calling this operation, ensure you have created an IM group with an invitation link, and that members have joined by using that link.'."\n" ."\n" .'- To create an IM group and add an invitation link, call the [AddChatGroup](~~2998429~~) and [AddChatGroupInviteLink](~~3019211~~) operations.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatGroupParticipants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListChatappMessage' => [ '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' => 'The business phone number.'."\n" ."\n" .'- For WhatsApp channels, view the business phone number in the [**Channel Management**](https://chatapp.console.aliyun.com/CustomerList) > **Management** > **WABA Management** > **Phone Number Management** console.'."\n" ."\n" .'- For Viber channels, view the Service ID in the [**Channel Management**](https://chatapp.console.aliyun.com/CustomerList) > **Management** > **Service Account Management** console.', 'type' => 'string', 'required' => true, 'example' => '8613800****', 'title' => ''], ], [ 'name' => 'StartTime', 'in' => 'query', 'schema' => ['description' => 'The start time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727057232686', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', 'schema' => ['description' => 'The end time. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1727057232686', 'title' => ''], ], [ 'name' => 'EventAction', 'in' => 'query', 'schema' => [ 'description' => 'The message type. Valid values:'."\n" .'- DOWN: outbound message.'."\n" .'- UP: inbound message.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'UP', 'title' => '', ], ], [ 'name' => 'UserNumber', 'in' => 'query', 'schema' => ['description' => 'The user phone number. This is the phone number that you imported when sending messages in the [**Channel Management**](https://chatapp.console.aliyun.com/CustomerList) > **Management** > **Message Sending** console.', 'type' => 'string', 'required' => false, 'example' => '86138***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **whatsapp**'."\n" ."\n" .'- **viber**', 'type' => 'string', 'required' => true, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'ClientAcceptStatus', 'in' => 'query', 'schema' => ['description' => 'The message receiving status of the user.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['description' => 'The template code. View the template code in the [**Channel Management**](https://chatapp.console.aliyun.com/CustomerList) > **Management** > **Template Design** console.', 'type' => 'string', 'required' => false, 'example' => '9938***', 'title' => ''], ], [ 'name' => 'GroupMessageId', 'in' => 'query', 'schema' => ['description' => 'The bulk message ID. View the bulk message ID in the [**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Management** > **Message List** > **Bulk Sending List** console.', 'type' => 'string', 'required' => false, 'example' => '9292****', 'title' => ''], ], [ 'name' => 'MessageStatus', 'in' => 'query', 'schema' => ['description' => 'The message status.', 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. View the Space ID in the [Channel Management](https://chatapp.console.aliyun.com/CustomerList) console.', 'type' => 'string', 'required' => true, 'example' => 'cams-************', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The pagination object.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => true, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '608F9CCA-B5EB-3D72-8047-B25D6D75BDEC', 'title' => ''], 'Data' => [ 'description' => 'The list of returned data objects.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'ConversationId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => '805a66**************************', 'title' => ''], 'BusinessNumber' => ['description' => 'The business phone number.', 'type' => 'string', 'example' => '86183********', 'title' => ''], 'ClientAcceptStatusName' => ['description' => 'The name of the message receiving status.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'Message' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'test', 'title' => ''], 'MessageTypeName' => ['description' => 'The message type name.', 'type' => 'string', 'example' => 'interactive', 'title' => ''], 'FailReason' => ['description' => 'The reason for the sending failure.', 'type' => 'string', 'example' => 'timeout', 'title' => ''], 'EventActionName' => ['description' => 'The name of the inbound or outbound message type. Valid values:'."\n" ."\n" .'- DOWN: outbound message.'."\n" ."\n" .'- UP: inbound message.', 'type' => 'string', 'example' => 'DOWN', 'title' => ''], 'Month' => ['description' => 'The month of the message.', 'type' => 'string', 'example' => '202507', 'title' => ''], 'LanguageCode' => ['description' => 'The template language. For more languages, see [Language codes](~~463420~~).', 'type' => 'string', 'example' => 'en', 'title' => ''], 'TemplateName' => ['description' => 'The template name.', 'type' => 'string', 'example' => 'picture_template', 'title' => ''], 'MessageType' => ['description' => 'The message type.', 'type' => 'string', 'example' => 'INTERACTIVE', 'title' => ''], 'SendTime' => ['description' => 'The sending time.', 'type' => 'string', 'example' => '2025-07-11T01:16:49.761+00:00', 'title' => ''], 'MessageStatusName' => ['description' => 'The message status name.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ClientReadStatus' => ['description' => 'The message read status.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'MessageSource' => ['description' => 'The message source.', 'type' => 'string', 'example' => 'api', 'title' => ''], 'FailBackFlag' => ['description' => 'Indicates whether the message falls back to SMS. Valid values:'."\n" ."\n" .'- Y: Yes.'."\n" ."\n" .'- N: No.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'UserNumber' => ['description' => 'The user phone number.', 'type' => 'string', 'example' => '86177********', 'title' => ''], 'TemplateCode' => ['description' => 'The template code.', 'type' => 'string', 'example' => '1103***************', 'title' => ''], 'MessageStatus' => ['description' => 'The message status.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'FailBackContent' => ['description' => 'The fallback content.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'EventAction' => ['description' => 'The inbound or outbound message type.', 'type' => 'string', 'example' => 'DOWN', 'title' => ''], 'ClientReadStatusName' => ['description' => 'The message read status name.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'UniqueMessageId' => ['description' => 'The unique message ID.', 'type' => 'string', 'example' => '20250911******************************', 'title' => ''], 'ChannelType' => ['description' => 'The channel type.', 'type' => 'string', 'example' => 'WHATSAPP', 'title' => ''], 'MessageId' => ['description' => 'The message ID.', 'type' => 'string', 'example' => '202509*******************', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Query message list', 'summary' => 'Queries the message list.', 'description' => '- You can call this operation to query the message list. You can also view the message list in the [**Channel Management**](https://chatapp.console.aliyun.com/CustomerList) > **Management** > **Message List** console.'."\n" ."\n" .'- This operation only supports querying the message list for WhatsApp and Viber channel types.'."\n" ."\n" .'- Before calling this operation, make sure that you have created a WhatsApp or Viber channel, bound a phone number or merchant account ID, created a template that has passed the review, and sent messages through the channel.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatappMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListChatappTemplate' => [ '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.', '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~~).', '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" ."\n" .'- **fail**: The template is rejected.'."\n" ."\n" .'- **auditing**: The template is being reviewed.'."\n" ."\n" .'- **unaudit**: The review is suspended.', 'type' => 'string', 'required' => false, 'example' => 'pass', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The pagination settings.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'default' => '10', 'title' => ''], 'Index' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'default' => '1', 'title' => ''], ], 'required' => false, 'example' => '"page": "{\\"index\\": 1,\\"size\\": 20}', '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.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '65921621816****'."\n", '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.', 'type' => 'string', 'required' => false, 'example' => 'skdi3kksloslikdkkdk', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the RAM user within the ISV account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '28251486512358****', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['description' => 'The type of the message template.'."\n" ."\n" .'- **WHATSAPP**'."\n" ."\n" .'- **VIBER**', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The code of the message template.', 'type' => 'string', 'required' => false, 'example' => '838888822*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'ListTemplate' => [ 'description' => 'The message templates.', 'type' => 'array', 'items' => [ 'description' => 'The queried templates.', 'type' => 'object', 'properties' => [ 'TemplateCode' => ['description' => 'The code of the message template.', 'type' => 'string', 'example' => '744c4b5c79c9432497a075bdfca3****', 'title' => ''], 'AuditStatus' => ['description' => 'The review state of the template. Valid values:'."\n" ."\n" .'- **pass**: The template is approved.'."\n" ."\n" .'- **fail**: The template is rejected.'."\n" ."\n" .'- **auditing**: The template is being reviewed.'."\n" ."\n" .'- **unaudit**: The review is suspended.', 'type' => 'string', 'example' => 'pass', 'title' => ''], 'Category' => ['description' => 'The category of the WhatsApp message template. Valid values:'."\n" ."\n" .'- **UTILITY**'."\n" ."\n" .'- **MARKETING**'."\n" ."\n" .'- **AUTHENTICATION**'."\n" ."\n" .'The category of the Viber template. Valid values:'."\n" ."\n" .'- **text**: template that contains only text'."\n" ."\n" .'- **image**: template that contains only images'."\n" ."\n" .'- **text\\_image\\_button**: template that contains text, images, and buttons'."\n" ."\n" .'- **text\\_button**: template that contains text and buttons'."\n" ."\n" .'- **document**: template that contains only documents'."\n" ."\n" .'- **video**: template that contains only videos'."\n" ."\n" .'- **text\\_video**: template that contains text and videos'."\n" ."\n" .'- **text\\_video\\_button**: template that contains text, videos, and buttons'."\n" ."\n" .'- **text\\_image**: template that contains text and images', 'type' => 'string', 'example' => 'UTILITY', 'title' => ''], 'Language' => ['description' => 'The language that is used in the message template. For more information, see [Language codes](~~463420~~).', '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.', 'type' => 'integer', 'format' => 'int64', 'example' => '1711006633000', 'title' => ''], 'TemplateName' => ['description' => 'The name of the message template.', 'type' => 'string', 'example' => 'hello_whatsapp', 'title' => ''], 'TemplateType' => ['description' => 'The type of the template. Valid values: WHATSAPP and VIBER.', 'type' => 'string', 'example' => 'WHATSAPP', 'title' => ''], 'Reason' => ['description' => 'The reason why the template was rejected.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Code' => ['description' => 'The HTTP status code returned.'."\n" ."\n" .'- A value of OK indicates that the call is successful.'."\n" ."\n" .'- Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ListChatappTemplate', 'summary' => 'Queries message templates.', 'description' => '### QPS limit'."\n" ."\n" .'This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-03-26T05:51:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-24T10:38:54.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-05-29T12:03:40.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-14T12:01:37.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:30:10.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-03-29T01:41:05.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-08T12:37:07.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChatappTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'ListCustomAudience' => [ 'summary' => 'Queries a list of custom audiences.', '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' => 'The Space ID of the Independent Software Vendor (ISV) sub-customer or the instance ID of the direct customers. This is the channel ID. Find the ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'required' => true, 'example' => '3939**', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'required' => false, 'example' => '339**', 'title' => ''], ], [ 'name' => 'TokenType', 'in' => 'query', 'schema' => ['description' => 'The token type.', 'type' => 'string', 'required' => false, 'example' => 'custom', 'title' => ''], ], [ 'name' => 'CustomAudienceName', 'in' => 'query', 'schema' => ['description' => 'The name of the custom audience.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '95', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '40', 'title' => ''], ], 'required' => true, 'example' => '', 'description' => 'The pagination settings.', 'title' => '', ], ], [ 'name' => 'CustomAudienceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the custom audience.', 'type' => 'string', 'required' => false, 'example' => '239**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39**', 'title' => ''], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '69', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'example' => '239**', 'title' => ''], 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'CustomAudienceId' => ['description' => 'The ID of the custom audience.', 'type' => 'string', 'example' => '339**', 'title' => ''], 'CustomAudienceName' => ['description' => 'The name of the custom audience.', 'type' => 'string', 'example' => 'custom audience name', 'title' => ''], 'TokenType' => ['description' => 'The token type.', 'type' => 'string', 'example' => 'custom', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'desc', 'title' => ''], 'CreateTime' => ['description' => 'The time when the audience was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1720356898', 'title' => ''], 'AdAccountId' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'example' => '339**', 'title' => ''], 'UpdateTime' => ['description' => 'The time when the audience was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '51', 'title' => ''], 'TokenTotal' => ['description' => 'The number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '70', 'title' => ''], 'UploadType' => ['description' => 'The upload type.', 'type' => 'string', 'example' => 'excel', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The returned data.', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the API call was successful.'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListCustomAudience', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListCustomAudience', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListDmAccount' => [ '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' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'SendType', 'in' => 'query', 'schema' => ['description' => 'The sending type.', 'type' => 'string', 'required' => false, 'example' => 'batch', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword.', 'type' => 'string', 'required' => false, 'example' => 'a', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xis-sx***', 'title' => ''], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Sendtype' => ['description' => 'The type of the sender address. Valid values:'."\n" ."\n" .'- batch: batch emails'."\n" .'- trigger: triggered emails', 'type' => 'string', 'example' => 'trigger', 'title' => ''], 'CreateTime' => ['description' => 'The time when the account was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1743579634000', 'title' => ''], 'MailAddressId' => ['description' => 'The ID of the email address.', 'type' => 'string', 'example' => 'a@b.com', 'title' => ''], 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'send1@xx.xx.asia', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query directMail accounts', 'summary' => 'Queries the DirectMail accounts under your Alibaba Cloud account.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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\\": \\"a@b.com\\",\\n \\"AccountName\\": \\"send1@xx.xx.asia\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ListDmTag' => [ 'summary' => '', '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' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'description' => '', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'description' => '', 'title' => ''], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'a', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'hgfh77-gfh55***', 'description' => '', 'title' => ''], 'Total' => ['type' => 'integer', 'format' => 'int64', 'example' => '42', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TagName' => ['type' => 'string', 'example' => 'xx', 'description' => '', 'title' => ''], 'TagDescription' => ['type' => 'string', 'example' => 'xx', 'description' => '', 'title' => ''], 'TagId' => ['type' => 'string', 'example' => 'xx', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListDmTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListFacebookPosts' => [ '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' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866***', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PermalinkUrl' => ['description' => 'The permalink URL.', 'type' => 'string', 'example' => 'https://xxxxxxx', 'title' => ''], 'MediaUrl' => ['description' => 'The original media URL.', 'type' => 'string', 'example' => 'https://xxxxxx07', 'title' => ''], 'CreatedTime' => ['description' => 'The time when the custom domain name was created.', 'type' => 'string', 'example' => '2025-04-08T10:44:48', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'MediaType' => ['description' => 'The media type.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Id' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'RequestNo' => ['description' => 'The request number.', 'type' => 'string', 'example' => '453645465***', 'title' => ''], 'FullPicture' => ['description' => 'The full picture.', 'type' => 'string', 'example' => 'N/A', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List facebook posts', 'summary' => 'Queries the list of Facebook posts.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFacebookPosts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListFlow' => [ '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' => 'formData', 'schema' => ['description' => 'The name of the flow.', 'type' => 'string', 'required' => false, 'example' => 'flow-21101', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Paging information.', 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['description' => 'The Space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-sa2ksj21jksd', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1612C226-E271-4CFE-9F18-4066D550F91B'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'The flow ID.', 'type' => 'string', 'example' => '92675332812643****', 'title' => ''], 'Categories' => [ 'title' => '', 'description' => 'The categories.', 'type' => 'array', 'items' => ['description' => 'The category.', 'type' => 'string', 'example' => 'SIGN_UP', 'title' => ''], 'example' => '', ], 'FlowName' => ['description' => 'The name of the flow.', 'type' => 'string', 'example' => 'flow-02020', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'A value of OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'ListFlow', 'summary' => 'Retrieves a list of WhatsApp flows.', 'description' => 'This operation allows a maximum of 5 requests per second (RPS) per account. Excess requests are throttled and may result in service interruptions.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:53.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-26T03:25:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'ListFlowNodeGroup' => [ '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' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only when RAM verification fails.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each API request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'Model' => [ 'description' => 'The request result data.', 'type' => 'array', 'items' => [ 'description' => 'The request result data.', 'type' => 'object', 'properties' => [ 'PublicExtend' => ['description' => 'The public extension field.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'integer', 'format' => 'int64', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List flow component groups', 'summary' => 'Lists flow component groups.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowNodeGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListFlowNodePrototypeV2' => [ 'summary' => 'Lists flow component prototypes.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '20'], ], [ 'name' => 'GroupCode', 'in' => 'query', 'schema' => ['description' => 'The code for the component group. Valid values:'."\n" ."\n" .'- Messaging: Message components.'."\n" ."\n" .'- Core: Core components.'."\n" ."\n" .'- Intelligence: Intelligence components.'."\n" ."\n" .'- Contact: Contact management components.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Core'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => true, 'enumValueTitles' => [], 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'Keyword', 'in' => 'query', 'schema' => ['description' => 'The search keyword. This parameter is used to perform a fuzzy query by flow component name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'WhatsApp'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['type' => 'string', 'description' => 'The ID of the request.', 'title' => '', 'example' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Model' => [ 'description' => 'A list of the returned data.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Status' => ['description' => 'The status of the component prototype. The default value is NORMAL.', 'type' => 'string', 'title' => '', 'example' => 'NORMAL'], 'GroupCode' => ['description' => 'The code of the component group.', 'type' => 'string', 'title' => '', 'example' => 'Core'], 'PublicExtend' => ['description' => 'The public extension information. This is a JSON string that contains extension information for the frontend to display the flow component. The fields are described as follows:'."\n" ."\n" .'- en: The English information about the flow component.'."\n" ."\n" .'- zh: The Chinese information about the flow component.'."\n" ."\n" .'- name: The name of the flow component.'."\n" ."\n" .'- remark: The remarks on the flow component.'."\n" ."\n" .'- order: The display order of the flow component.'."\n" ."\n" .'- style: The style of the flow component.'."\n" ."\n" .'- svg: The URL of the flow component icon.'."\n" ."\n" .'- icon: This field is deprecated.'."\n" ."\n" .'- bgcolor: The background color of the icon.', 'type' => 'string', 'title' => '', 'example' => '{\\"i18n\\": {\\"en\\": {\\"name\\": \\"Send a WhatsApp Message\\", \\"remark\\": \\"Send a message with the ability for the user to reply utilizing WhatsApp specific features.\\"}, \\"zh\\": {\\"name\\": \\"Send WhatsApp messages\\", \\"remark\\": \\"Send a message that allows users to reply using specific features of WhatsApp\\"}}, \\"order\\": \\"9000\\", \\"style\\": {\\"svg\\": \\"https://img.alicdn.com/***********************************\\", \\"icon\\": \\"https://img.alicdn.com/***********************************\\", \\"bgcolor\\": \\"blue\\"}}'], 'Code' => ['description' => 'The code of the component prototype.', 'type' => 'string', 'title' => '', 'example' => 'SendWhatsAppMessageNode'], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" ."\n" .'- true: The call was successful.'."\n" ."\n" .'- false: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'ListFlowNodePrototypeV2', 'description' => '- You can call this API operation to query flow component prototypes. You can also view the prototypes on the orchestration canvas in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) by clicking a flow name.'."\n" ."\n" .'- You can use the optional parameters for this operation to filter flow component prototypes. If you do not specify any optional parameters, all flow component prototypes are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowNodePrototypeV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"\\",\\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"}]', 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '254867', 'abilityTreeNodes' => ['FEATUREcams9OUKUU'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListFlowVersion' => [ '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' => 'The flow code. Find the flow code in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'PageNo', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '5'], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The status of the flow version. Valid values:'."\n" ."\n" .'- DRAFT: The flow is a draft.'."\n" ."\n" .'- DELETED: The flow is deleted.'."\n" ."\n" .'- ONLINE: The flow is published.'."\n" ."\n" .'- OFFLINE: The flow is unpublished.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['DRAFT' => 'DRAFT', 'DELETED' => 'DELETED', 'ONLINE' => 'ONLINE', 'OFFLINE' => 'OFFLINE'], 'title' => '', 'example' => 'DRAFT', ], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'Business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'List Flow Versions', 'summary' => 'Lists flow versions.', 'description' => '- You can call this API operation to query flow versions. You can also view flow versions in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) by clicking a flow name to open the orchestration canvas.'."\n" ."\n" .'- Before calling this API operation, make sure that you have created one or more flows.'."\n" ."\n" .'- If you have not created any flows, create a flow in the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) or call the [CreateChatFlow](~~2937204~~) API operation.'."\n" ."\n" .'- The optional parameters for this API operation are filter conditions. If you do not specify any optional parameters, all flow versions are returned.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListInstagramPage' => [ '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' => 'The instance ID. Only non-Alibaba Cloud hosts are supported.', 'type' => 'string', 'required' => true, 'example' => 'inst-8t47hh***5pyj0ps', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'The message returned with the result.', 'type' => 'string', 'example' => 'ok', 'title' => ''], 'RequestId' => ['description' => 'The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting.', 'type' => 'string', 'example' => 'dsfdsf-3jfj***', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'BeebotInfo' => [ 'description' => 'The Chatbot information.', 'type' => 'object', 'properties' => [ 'BeebotInstanceId' => ['description' => 'The Chatbot instance ID.', 'type' => 'string', 'example' => 'instance1', 'title' => ''], 'BeebotNamespaceId' => ['description' => 'The namespace ID.', 'type' => 'string', 'example' => 'name1', 'title' => ''], ], 'example' => '', 'title' => '', ], 'AgentInfo' => [ 'description' => 'The agent information.', 'type' => 'object', 'properties' => [ 'AgentKeywords' => ['description' => 'The agent-related configurations.', 'type' => 'string', 'example' => 'aaa,bbb', 'title' => ''], 'AgentNoKeywords' => ['description' => 'The agent-related configurations.', 'type' => 'string', 'example' => 'Y', 'title' => ''], ], 'example' => '', 'title' => '', ], 'InstagramInfo' => [ 'description' => 'The Instagram page information.', 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The page ID.', 'type' => 'string', 'example' => '213254324532523', 'title' => ''], 'QueueFlag' => ['description' => 'Indicates whether receipts are received through a queue. Valid values:'."\n" ."\n" .'- Y: Yes.'."\n" ."\n" .'- N: No.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'HttpFlag' => ['description' => 'Indicates whether receipts are received through HTTP. Valid values:'."\n" .'- Y: Yes.'."\n" .'- N: No.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'AccountId' => ['description' => 'The ID of the account to which the page belongs.', 'type' => 'string', 'example' => '176546546464', 'title' => ''], 'StatusQueue' => ['description' => 'The queue for status report notifications.', 'type' => 'string', 'example' => 'AAA', 'title' => ''], 'UpQueue' => ['description' => 'The queue for upstream message notifications.', 'type' => 'string', 'example' => 'BBB', 'title' => ''], 'PageName' => ['description' => 'The page name.', 'type' => 'string', 'example' => 'iwhaclecloud-2', 'title' => ''], 'ConnectionStatus' => ['description' => 'The endpoint connection status. Valid values:'."\n" ."\n" .'- **Pending**: Being modified.'."\n" ."\n" .'- **Connecting**: Connecting.'."\n" ."\n" .'- **Connected**: Connected.'."\n" ."\n" .'- **Disconnecting**: Disconnecting.'."\n" ."\n" .'- **Disconnected**: Not connected.'."\n" ."\n" .'- **Deleting**: Being deleted.'."\n" ."\n" .'- **ServiceDeleted**: The service associated with the endpoint has been deleted.', 'type' => 'string', 'example' => 'connected', 'title' => ''], 'UpCallbackUrl' => ['description' => 'The callback URL for upstream messages over HTTP.', 'type' => 'string', 'example' => 'HTTP://WWW.***.COM', 'title' => ''], 'QueueName' => ['description' => 'The queue name.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'AccountName' => ['description' => 'The account name.', 'type' => 'string', 'example' => 'matrryhtr', 'title' => ''], 'StatusCallbackUrl' => ['description' => 'The callback URL for status reports over HTTP.', 'type' => 'string', 'example' => 'HTTP://WWW.***.COM', 'title' => ''], ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List instagram public pages', 'summary' => 'Retrieves the Instagram pages associated with an instance.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '1', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A***66411B2O', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PermalinkUrl' => ['type' => 'string', 'example' => 'https://xxxxxxxx', 'description' => '', 'title' => ''], 'MediaUrl' => ['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', 'description' => '', 'title' => ''], 'CreatedTime' => ['type' => 'string', 'example' => '2024-09-30T15:53:01+08:00', 'description' => '', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'MediaType' => ['type' => 'string', 'example' => 'image', 'description' => '', 'title' => ''], 'Id' => ['type' => 'string', 'example' => '111', 'description' => '', 'title' => ''], 'FullPicture' => ['type' => 'string', 'example' => 'https://xxxxxxxx'."\n", 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstagramPosts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListInstance' => [ 'summary' => 'Lists instances.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '205978', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **whatsapp**'."\n" ."\n" .'- **messenger**'."\n" ."\n" .'- **instagram**'."\n" ."\n" .''."\n" ."\n" .'- **viber**'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => 'VIBER', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The instance name.', 'type' => 'string', 'required' => false, 'example' => 'viber_ins', 'title' => ''], ], [ 'name' => 'SubmitTime', 'in' => 'query', 'schema' => ['description' => 'The submission time, in `YYYY-MM-DD HH:MM:SS` format.', 'type' => 'string', 'required' => false, 'example' => '2023-12-12 00:00:00', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of items to return per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '87', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '92', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the resource group that contains the instance.', 'type' => 'string', 'required' => false, 'example' => '11', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The instance ID. Use this parameter for non-Alibaba Cloud hosts only.', 'type' => 'string', 'required' => false, 'example' => 'r-uf6wd7pkyjwxvlxfhk', 'title' => ''], ], [ 'name' => 'FilterStr', 'in' => 'query', 'schema' => ['description' => 'The filter string for the query.', 'type' => 'string', 'required' => false, 'example' => 'aa', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries that match the specified criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '2993*****', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CountryId' => ['description' => 'The country ID.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ContactMail' => ['description' => 'The contact email address.', 'type' => 'string', 'example' => 'ma**@gmail.com', 'title' => ''], 'ResourceRegionId' => ['description' => 'The ID of the region where the resource is located.', 'type' => 'string', 'example' => '11', 'title' => ''], 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => '12', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '29339****', 'title' => ''], 'OfficeAddress' => ['description' => 'The office address.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the instance was submitted.', 'type' => 'string', 'example' => '2023-12-12 00:00:00', 'title' => ''], 'InstanceName' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'viber_ins', 'title' => ''], 'CustSpaceId' => ['description' => 'The customer space ID.', 'type' => 'string', 'example' => 'dad-gf**', 'title' => ''], 'IsvTerms' => ['description' => 'The ISV terms.', 'type' => 'string', 'example' => 'aa', 'title' => ''], 'FacebookBmId' => ['description' => 'The ID of the associated Facebook Business Manager account.', 'type' => 'string', 'example' => '1', 'title' => ''], 'InstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'ins', 'title' => ''], 'ChannelType' => ['description' => 'The channel type.', 'type' => 'string', 'example' => 'VIBER', 'title' => ''], 'State' => ['description' => 'The state of the instance.', 'type' => 'string', 'example' => 'published', 'title' => ''], ], 'description' => 'The details of the instance.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'An array of objects, each representing an instance.', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- `OK` indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see the [Error Code List](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call succeeded.'."\n" ."\n" .'- **true**: The call succeeded.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => 'The data returned.', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/*'], ], ], ], ], '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\\": \\"example\\",\\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"}]', ], 'ListMarketingFlow' => [ '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' => 'The campaign status.', 'type' => 'string', 'required' => false, 'example' => 'sucess', 'title' => ''], ], [ 'name' => 'RelatedGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the associated group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '68', 'title' => ''], ], [ 'name' => 'RelatedFlowCode', 'in' => 'query', 'schema' => ['description' => 'The ID of the associated flow.', 'type' => 'string', 'required' => false, 'example' => 'asdfsdfdsfs', 'title' => ''], ], [ 'name' => 'ActivityName', 'in' => 'query', 'schema' => ['description' => 'The name of the node task instance.', 'type' => 'string', 'required' => false, 'example' => 'werewew', 'title' => ''], ], [ 'name' => 'ActivityCode', 'in' => 'query', 'schema' => ['description' => 'The campaign code. You can use the system code or modify it to use a custom code.', 'type' => 'string', 'required' => false, 'example' => 'rewrwerw', 'title' => ''], ], [ 'name' => 'PageIndex', 'in' => 'query', 'schema' => ['description' => 'The current page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', 'schema' => ['description' => 'The number of entries per page.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => ['description' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'type' => 'string', 'required' => false, 'example' => 'ALICOM_OPAAS', 'default' => '', 'title' => ''], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: "{}".', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries in the list.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'CB6122C9-09B5-5926-**476A96CB0', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'RelatedFlowName' => ['description' => 'The name of the associated flow.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'ActivityStatus' => ['description' => 'The campaign status.', 'type' => 'string', 'example' => 'active', 'title' => ''], 'ActivityName' => ['description' => 'The campaign name.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'ActivityCode' => ['description' => 'The campaign code.', 'type' => 'string', 'example' => '3243243***', 'title' => ''], 'ExecutionType' => ['description' => 'The execution method.', 'type' => 'string', 'example' => '1(默认corn)', 'title' => ''], 'RelatedGroupId' => ['description' => 'The ID of the associated group.', 'type' => 'string', 'example' => '54354**', 'title' => ''], 'SpecificTime' => ['description' => 'The specific time. This parameter is valid when the execution method is set to 2.', 'type' => 'string', 'example' => '特定时间(执行方式为2时)'."\n" ."\n", 'title' => ''], 'Params' => ['description' => 'The custom user parameters.', 'type' => 'object', 'example' => '{\\"CustomerLimit\\":false}', 'title' => ''], 'BizExtend' => ['description' => 'The business extension information. Default value: "{}".', 'type' => 'object', 'example' => '{}', 'title' => ''], 'RelatedGroupName' => ['description' => 'The name of the associated group.', 'type' => 'string', 'example' => 'AAA', 'title' => ''], 'EndDate' => ['description' => 'The end time.', 'type' => 'string', 'example' => '2025-01-01 XX1:11:11', 'title' => ''], 'StartDate' => ['description' => 'The start time.', 'type' => 'string', 'example' => '2025-01-XX 11:11:11', 'title' => ''], 'GmtCreate' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2025-XX-01 11:11:11', 'title' => ''], 'TenantCode' => ['description' => 'The tenant.', 'type' => 'string', 'example' => '1111', 'title' => ''], 'ActivityDesc' => ['description' => 'The campaign description.', 'type' => 'string', 'example' => 'aaa', 'title' => ''], 'RelatedFlowCode' => ['description' => 'The associated flow code.', 'type' => 'string', 'example' => 'dsafdsf***', 'title' => ''], 'GmtModifier' => ['description' => 'The modification time (deprecated).', 'type' => 'string', 'example' => 'N/A', 'title' => ''], 'Id' => ['description' => 'The operational activity ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99', 'title' => ''], 'CronExpression' => ['description' => 'The upgrade start time. The upgrade start time is specified as a cron expression.'."\n" ."\n" .'For example, `0 0 4 1/1 * ?` indicates that the upgrade starts at 4:00 on the first day of each month and is performed at 4:00 every day.', 'type' => 'string', 'example' => '0 0 4 1/1 * ?', 'title' => ''], 'ParamFlag' => ['description' => 'Indicates whether custom parameters are enabled.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'BizCode' => ['description' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" ."\n" .'- true: The call was successful. '."\n" .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query marketing campaign list', 'summary' => 'Queries a list of marketing campaigns.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListMessageCampaign' => [ 'summary' => 'Retrieves a list of budgets.', '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' => 'The Space ID of the ISV sub-customer or the instance ID of the direct customer. You can view this ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'required' => true, 'example' => '239***', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Meta ad account.', 'type' => 'string', 'required' => false, 'example' => '239**', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the budget.', 'type' => 'string', 'required' => false, 'example' => 'AVAILABLE', 'title' => ''], ], [ 'name' => 'CampaignName', 'in' => 'query', 'schema' => ['description' => 'The name of the campaign.', 'type' => 'string', 'required' => false, 'example' => 'test-campaign', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'Size' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '55', 'title' => ''], 'Index' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '7', 'title' => ''], ], 'required' => true, 'example' => '', 'description' => 'The pagination parameters.', 'title' => '', ], ], [ 'name' => 'CampaignId', 'in' => 'query', 'schema' => ['description' => 'The ID of the budget.', 'type' => 'string', 'required' => false, 'example' => '233**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '23**', 'title' => ''], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '70', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The Page ID for Messenger.', 'type' => 'string', 'example' => '238***', 'title' => ''], 'Status' => ['description' => 'The status of the campaign.', 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''], 'CampaignId' => ['description' => 'The campaign ID.', 'type' => 'string', 'example' => '233**', 'title' => ''], 'CreateTime' => ['description' => 'The time when the campaign was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '173029392838', 'title' => ''], 'AdAccountId' => ['description' => 'The ID of the Meta ad account.', 'type' => 'string', 'example' => '2339**', 'title' => ''], 'CampaignName' => ['description' => 'The name of the campaign.', 'type' => 'string', 'example' => 'campaign-name', 'title' => ''], 'Budget' => ['description' => 'The budget.', 'type' => 'integer', 'format' => 'int64', 'example' => '62', 'title' => ''], 'BudgetType' => ['description' => 'The budget type.', 'type' => 'string', 'example' => 'daily', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The returned data object.', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: successful.'."\n" ."\n" .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListMessageCampaign', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListMessengerSubscriptionToken' => [ 'summary' => 'Queries custom audiences and subscription tokens.', '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' => 'The space ID of the ISV sub-customer or the instance ID. View the ID on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The page ID for Messenger.', 'type' => 'string', 'required' => true, 'example' => '239***', 'title' => ''], ], [ 'name' => 'TokenType', 'in' => 'query', 'schema' => [ 'description' => 'The token type.', 'enumValueTitles' => ['customAudience' => 'The custom audience.'], 'type' => 'string', 'required' => true, 'example' => 'customAudience', 'title' => '', ], ], [ 'name' => 'CustomAudienceId', 'in' => 'query', 'schema' => ['description' => 'The custom audience ID.', 'type' => 'string', 'required' => false, 'example' => '233**', 'title' => ''], ], [ 'name' => 'PageKey', 'in' => 'query', 'schema' => ['description' => 'The pagination key.', 'type' => 'string', 'required' => false, 'example' => '2ie**', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '67', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ei**', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The page ID for Messenger.', 'type' => 'string', 'example' => '239***', 'title' => ''], 'TopicTitle' => ['description' => 'The message\'s title', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'CustomAudienceId' => ['description' => 'The custom audience ID.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'RecipientId' => ['description' => 'The customer\'s Page-scoped ID (PSID)', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'TokenExpiryTimestamp' => ['description' => 'The expiration time of the security token.', 'type' => 'integer', 'format' => 'int64', 'example' => '172546854885', 'title' => ''], 'CreationTimestamp' => ['description' => 'The time when the security token was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '172546854885', 'title' => ''], 'NotificationMessagesToken' => ['description' => 'The page-scoped ID of the customer.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'NotificationMessagesReoptin' => ['description' => 'The re-subscription status.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'NextEligibleTime' => ['description' => 'The time when the application can send the next marketing message to the recipient.', 'type' => 'integer', 'format' => 'int64', 'example' => '172546854885', 'title' => ''], 'NotificationMessagesTimezone' => ['description' => 'The customer\'s time zone.', 'type' => 'string', 'example' => 'Example', 'title' => ''], 'UserTokenStatus' => ['description' => 'The status of the security token.', 'type' => 'string', 'example' => 'Example', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'example' => '', 'description' => 'The returned data.', 'title' => '', ], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- A return value of OK indicates that the request was successful.'."\n" ."\n" .'- For a list of other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'NextPage' => ['description' => 'The identifier for the next page. Pass this value to query the next page.', 'type' => 'string', 'example' => '3399***', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: successful.'."\n" ."\n" .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListMessengerSubscriptionToken', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMessengerSubscriptionToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListPageAdAccount' => [ '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' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-**', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The PageId of Messenger.', 'type' => 'string', 'required' => true, 'example' => '230***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39**', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'PageId' => ['description' => 'The PageId of Messenger.', 'type' => 'string', 'example' => '2030***', 'title' => ''], 'AdAccountName' => ['description' => 'The name of the ad account.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'USD', 'title' => ''], 'AdAccountId' => ['description' => 'The Meta ad account ID.', 'type' => 'string', 'example' => '29393****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, refer to [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query page ad accounts', 'summary' => 'Queries the list of ad accounts bound to a page.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListPageAdAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListPhoneMessageQrdl' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'abilityTreeCode' => '200921', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '86163********', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer, or the instance ID of the direct customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-8filvjc8snw', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'QrImageUrl' => ['description' => 'The URL of the QR code image.', 'type' => 'string', 'example' => 'https://img.png', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '86138009****', 'title' => ''], 'QrdlCode' => ['description' => 'The QR code identifier.', 'type' => 'string', 'example' => 'IUIED999', 'title' => ''], 'DeepLinkUrl' => ['description' => 'The deep link URL.', 'type' => 'string', 'example' => 'https://wa.msg/', 'title' => ''], 'GenerateQrImage' => ['description' => 'The type of the generated image.', 'type' => 'string', 'example' => 'PNG', 'title' => ''], 'PrefilledMessage' => ['description' => 'The prefilled message content.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response code. OK indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Query message QR code list', 'summary' => 'Queries the list of message QR codes.', 'description' => 'The queries per second (QPS) limit for this operation is 5 per user. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation as appropriate.', 'changeSet' => [ ['createdAt' => '2025-07-10T08:52:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:55.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneMessageQrdl'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:ListPhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListProduct' => [ '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. You can get it from the Meta platform.', 'type' => 'string', 'required' => true, 'example' => '2939838xxxx', 'title' => ''], ], [ 'name' => 'Fields', 'in' => 'query', 'schema' => ['description' => 'A list of fields to return. Separate multiple fields with a comma (,).'."\n" .'For more information, see [Product fields](~~2579419~~).', 'type' => 'string', 'required' => false, 'example' => 'id,name', 'title' => ''], ], [ 'name' => 'Before', 'in' => 'query', 'schema' => ['description' => 'The cursor that points to the end of the previous page of results.', 'type' => 'string', 'required' => false, 'example' => 'wiidkd939kek93', 'title' => ''], ], [ 'name' => 'After', 'in' => 'query', 'schema' => ['description' => 'The cursor that points to the start of the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'kdkii48jfjjei3', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The number of items to return. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '73', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'C2939838xxxx', 'title' => ''], ], [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['description' => 'The WhatsApp Business Account (WABA) ID.', 'type' => 'string', 'required' => true, 'example' => '3848747xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The message returned if the request fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Model' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'Paging' => [ 'description' => 'Paging details.', 'type' => 'object', 'properties' => [ 'Cursors' => [ 'description' => 'The cursors for paging.', 'type' => 'object', 'properties' => [ 'Before' => ['description' => 'The cursor that points to the previous page.', 'type' => 'string', 'example' => 'sjjsjdjjdjd83883', 'title' => ''], 'After' => ['description' => 'The cursor that points to the next page.', 'type' => 'string', 'example' => 'sjsuueu83838', 'title' => ''], ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => ['description' => 'Product data.', 'type' => 'object', 'example' => '{"id":"293983883", "name":"product1"}', 'title' => ''], 'example' => '', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'ListProduct', 'summary' => 'Retrieves products in a catalog.', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProduct'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListProduct', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListProductCatalog' => [ 'summary' => 'Queries the catalog list of the Meta Business platform.', '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 ID of the business platform where the WABA is located. You can view the business platform ID in the Chat App Message Service console after WABA registration is complete.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '105048970863****', 'title' => ''], ], [ 'name' => 'Before', 'in' => 'query', 'schema' => ['description' => 'The end position of the previous page for pagination.', 'type' => 'string', 'required' => false, 'example' => 'wiidkd939kek93', 'title' => ''], ], [ 'name' => 'After', 'in' => 'query', 'schema' => ['description' => 'The start position of the next page for pagination.', 'type' => 'string', 'required' => false, 'example' => 'kdkii48jfjjei3', 'title' => ''], ], [ 'name' => 'Fields', 'in' => 'query', 'schema' => ['description' => 'The list of fields, separated by commas (,).'."\n" .'For specific fields, see [Catalog fields](~~2579419~~).', 'type' => 'string', 'required' => false, 'example' => 'id,name', 'title' => ''], ], [ 'name' => 'Limit', 'in' => 'query', 'schema' => ['description' => 'The number of entries to query. Valid values: 1 to 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '73', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'C29398882929', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Model' => [ 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'Paging' => [ 'description' => 'The pagination details.', 'type' => 'object', 'properties' => [ 'Cursors' => [ 'description' => 'The cursor position for pagination.', 'type' => 'object', 'properties' => [ 'Before' => ['description' => 'The position of the previous record.', 'type' => 'string', 'example' => 'sjjsjdjjdjd83883', 'title' => ''], 'After' => ['description' => 'The position of the next record.', 'type' => 'string', 'example' => 'sjsuueu83838', 'title' => ''], ], 'example' => '', 'title' => '', ], ], 'example' => '', 'title' => '', ], 'Data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => ['description' => 'The returned object.', 'type' => 'object', 'example' => '{"id":"2999293993", "name":"catalog_name"}', 'title' => ''], 'example' => '', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'List product catalogs', 'description' => 'The China (Hangzhou) region is used as an example. The China (Hangzhou) region is used as an example. The China (Hangzhou) region is used as an example. The per-user QPS limit for this API is 10 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductCatalog'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListProductCatalog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ListViberServiceMessage' => [ 'summary' => '', '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' => ['type' => 'string', 'required' => true, 'example' => 'cams-8e4**96uhvk', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'successful', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'ddhjdn-dnjdnkdjknd**', 'description' => '', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'DestinationCountryId' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '["213|DZ"]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'State' => ['type' => 'string', 'example' => 'stop', 'description' => '', 'title' => ''], 'IndustryInvolved' => ['type' => 'string', 'example' => '医疗服务', 'description' => '', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '阿尔及利亚', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'DestinationInternationalCountryId' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '["213|DZ"]', 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'MessageDestinationCountry' => [ 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'example' => '阿尔及利亚'."\n", 'title' => ''], 'example' => '', 'description' => '', 'title' => '', ], 'BusinessAccountName' => ['type' => 'string', 'example' => '测试', 'description' => '', 'title' => ''], 'ServiceId' => ['type' => 'string', 'example' => '25644', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', 'description' => '', 'title' => '', ], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListViberServiceMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ListWhatAppTemplate' => [ 'summary' => 'Lists message templates.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '121097', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'HetuParams', 'in' => 'query', 'schema' => ['description' => 'This parameter is reserved for internal use.', 'type' => 'string', 'required' => false, 'example' => '{}', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'example' => '2983883892', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID generated by Alibaba Cloud for the request. Use this ID to troubleshoot and debug issues.', 'type' => 'string', 'example' => '4AAC06A8-1B23-5616-AAAE-A7E7D7E48ACB', 'title' => ''], 'Code' => ['description' => 'The response status code. `200` indicates a successful request.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message. `success` indicates a successful request.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => ['description' => 'The response data.', 'type' => 'string', 'example' => 'True', 'title' => ''], 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListWhatAppTemplate', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListWhatAppTemplate', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#CustSpaceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4AAC06A8-1B23-5616-AAAE-A7E7D7E48ACB\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"True\\",\\n \\"Total\\": 1,\\n \\"AccessDeniedDetail\\": \\"{}\\"\\n}","type":"json"}]', ], 'ModifyChatappTemplate' => [ '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 list of message template components.'."\n" ."\n" .'> When Category is set to AUTHENTICATION, Components cannot contain a node with Type set to HEADER. When Type is set to BODY or FOOTER and the Text content is empty, the content is automatically generated.', 'type' => 'array', 'items' => [ 'description' => 'The message template component.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The component type.'."\n" ."\n" .'- **BODY**'."\n" ."\n" .'- **HEADER**'."\n" ."\n" .'- **FOOTER**'."\n" ."\n" .' - **BUTTONS**'."\n" ."\n" .'- **CAROUSEL**'."\n" ."\n" .'- **LIMITED_TIME_OFFER**'."\n" ."\n" .'> - For WhatsApp templates, the character length of the **BODY** component cannot exceed 1024 characters. The character length of the **HEADER** and **FOOTER** components cannot exceed 60 characters.', 'type' => 'string', 'required' => true, 'example' => 'BODY'], 'Text' => ['title' => '', 'description' => 'The text of the message to be sent.'."\n" ."\n" .'> When Category is set to AUTHENTICATION, this property value is empty.', 'type' => 'string', 'example' => 'hello chatapp', 'required' => false], 'Format' => ['title' => '', 'description' => 'The media resource type.'."\n" ."\n" .'- **TEXT**: text '."\n" ."\n" .'- **IMAGE**: image '."\n" ."\n" .'- **DOCUMENT**: document '."\n" ."\n" .'- **VIDEO**: video', 'type' => 'string', 'example' => 'TEXT', 'required' => false], 'Url' => ['title' => '', 'description' => 'The material path.', 'type' => 'string', 'example' => 'https://img.****.com/png_preview/00/10/24/1GygxVK3F4.jpg', 'required' => false], 'Caption' => ['title' => '', 'description' => 'The description.'."\n" .'> A description can be added when Type is set to **HEADER** and Format is set to **IMAGE/DOCUMENT/VIDEO**.', 'type' => 'string', 'example' => ' This is a video', 'required' => false], 'FileName' => ['title' => '', 'description' => 'The file name.'."\n" .'> A file name can be specified when Type is set to **HEADER** and Format is set to **DOCUMENT**.', 'type' => 'string', 'example' => 'video', 'required' => false], 'Buttons' => [ 'title' => '', 'description' => 'The button list. This parameter applies only to the **BUTTONS** component.'."\n" ."\n" .'> WhatsApp button limits:'."\n" .'> - For WhatsApp templates with Category set to MARKETING or UTILITY, a maximum of 10 buttons are allowed.'."\n" .'> - Only one PHONE_NUMBER button is allowed.'."\n" .'> - A maximum of two URL buttons are allowed.'."\n" .'> - QUICK_REPLY buttons cannot be mixed in random order with PHONE_NUMBER or URL buttons.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The button definition.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The button type.'."\n" ."\n" .'- **PHONE_NUMBER**: phone call button'."\n" ."\n" .'- **URL**: web button'."\n" ."\n" .'- **QUICK_REPLY**: quick reply button'."\n" ."\n" .'- **COPY_CODE**: copy verification code or coupon code'."\n" ."\n" .'- **ONE_TAP**: autofill button for AUTHENTICATION templates'."\n" ."\n" .'- **ZERO_TAP**: autofill button for AUTHENTICATION templates'."\n" ."\n" .'- **MPM**: multi-product catalog'."\n" ."\n" .'- **CATALOG**: catalog'."\n" ."\n" .'- **FLOW**: open a WhatsApp flow'."\n" ."\n" .'> - For WhatsApp templates with Category set to AUTHENTICATION, only one button is allowed, and the type can only be COPY_CODE or ONE_TAP. When the type is COPY_CODE, Text is required. When the type is ONE_TAP, Text (displayed when the target application is not installed on the device, indicating the name of the copy verification code button) is required, and SignatureHash, PackageName, and AutofillText are required.', 'type' => 'string', 'required' => true, 'example' => 'PHONE_NUMBER'], 'Text' => ['title' => '', 'description' => 'The button text.', 'type' => 'string', 'example' => 'phone-button-text', 'required' => false], 'PhoneNumber' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '+861388888****', 'required' => false], 'Url' => ['title' => '', 'description' => 'The URL to visit when the button is clicked.', 'type' => 'string', 'example' => 'https://www.website.com/***', 'required' => false], 'UrlType' => ['title' => '', 'description' => 'The URL type.'."\n" ."\n" .'- **static**: static'."\n" ."\n" .'- **dynamic**: dynamic', 'type' => 'string', 'example' => 'dynamic', 'required' => false], 'SignatureHash' => ['title' => '', 'description' => 'Use the properties under SupportedApps instead.', 'type' => 'string', 'deprecated' => true, 'example' => '29dkeke', 'required' => false], 'PackageName' => ['title' => '', 'description' => 'Use the properties under SupportedApps instead.', 'type' => 'string', 'deprecated' => true, 'example' => 'com.demo', 'required' => false], 'AutofillText' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is AUTHENTICATION and Button Type is ONE_TAP or ZERO_TAP. The button text for the WhatsApp autofill operation.', 'type' => 'string', 'example' => 'Autofill', 'required' => false], 'IsOptOut' => ['title' => '', 'description' => 'Valid when the WhatsApp template Category is Marketing and Button type is QUICK_REPLY. Indicates the button is a marketing opt-out button. If the customer clicks this button and the send control operation is configured in ChatApp, subsequent Marketing messages will not be sent to the customer.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'CouponCode' => ['title' => '', 'description' => 'The coupon code value. Only letters and numbers are supported. You can pass in a variable such as $(couponCode) and provide the actual coupon code when sending the message.', 'type' => 'string', 'example' => '120293', 'required' => false], 'FlowId' => ['title' => '', 'description' => 'Flow ID。', 'type' => 'string', 'example' => '664597077870605', 'required' => false], 'FlowAction' => [ 'title' => '', 'description' => 'The flow data event type. Valid values:'."\n" ."\n" .'- DATA_EXCHANGE: data exchange.'."\n" ."\n" .'- NAVIGATE: navigation.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'NAVIGATE', 'required' => false, ], 'NavigateScreen' => ['title' => '', 'description' => 'The navigate screen. Required when FlowAction is set to NAVIGATE.', 'type' => 'string', 'example' => 'DETAILS', 'required' => false], 'SupportedApps' => [ 'title' => '', 'description' => 'The list of supported applications.', 'type' => 'array', 'items' => [ 'description' => 'The list of supported applications.', 'type' => 'object', 'properties' => [ 'SignatureHash' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is AUTHENTICATION and Button Type is ONE_TAP or ZERO_TAP. The signature hash value for WhatsApp to launch the application.', 'type' => 'string', 'example' => 'fk39kd93ks9', 'required' => false], 'PackageName' => ['title' => '', 'description' => 'Required when the WhatsApp template Category is AUTHENTICATION and Button Type is ONE_TAP or ZERO_TAP. The package name for WhatsApp to launch the application.', 'type' => 'string', 'example' => 'com.example.myapplication', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'maxItems' => 5, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'ThumbUrl' => ['title' => '', 'description' => 'Invalid field.', 'type' => 'string', 'example' => 'https://cdn.multiplymall.mobiapp.cloud/cloudcode/yc-165407506207478-165511576113195/20220905/ec5b9737-1507-4208-bb27-8da3958da961.jpg?x-oss-process=image/resize,w_100', 'required' => false], 'Duration' => ['title' => '', 'description' => 'Invalid field.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'required' => false], 'FileType' => ['title' => '', 'description' => 'Invalid field.', 'type' => 'string', 'example' => 'docx', 'required' => false], 'CodeExpirationMinutes' => ['title' => '', 'description' => 'The validity period (in minutes) of the verification code in WhatsApp AUTHENTICATION templates. Valid only for WhatsApp messages when Category is AUTHENTICATION and Component Type is Footer. This information is displayed in the Footer section.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '90', 'minimum' => '1', 'example' => '5', 'required' => false], 'AddSecretRecommendation' => ['title' => '', 'description' => 'Valid for WhatsApp templates when Category is AUTHENTICATION and Component Type is Body. Displays a message in the Body section advising not to share the verification code with others.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'HasExpiration' => ['title' => '', 'description' => 'Specifies whether the coupon code has an expiration time. Used when type is set to LIMITED_TIME_OFFER.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'Cards' => [ 'description' => 'The list of Carousel template cards.', 'type' => 'array', 'items' => [ 'description' => 'The list of Carousel template cards.', 'type' => 'object', 'properties' => [ 'CardComponents' => [ 'title' => '', 'description' => 'The list of components in the Carousel card.', 'type' => 'array', 'items' => [ 'description' => 'The list of components in the Carousel card.', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'The component type. Valid values:'."\n" ."\n" .'- **BODY**'."\n" ."\n" .'- **HEADER**'."\n" ."\n" .'- **BUTTONS**', 'type' => 'string', 'required' => true, 'example' => 'BODY'], 'Format' => ['title' => '', 'description' => 'The media resource type. Valid when Type is set to HEADER.'."\n" ."\n" .'- **IMAGE**: image '."\n" ."\n" .'- **VIDEO**: video', 'type' => 'string', 'example' => 'IMAGE', 'required' => false], 'Text' => ['title' => '', 'description' => 'The BODY content in the Carousel card.', 'type' => 'string', 'example' => 'Who is the very powerful team', 'required' => false], 'Url' => ['title' => '', 'description' => 'The material path.', 'type' => 'string', 'example' => 'https://alibaba.com/****/img.png'."\n", 'required' => false], 'Buttons' => [ 'title' => '', 'description' => 'The button list. This parameter applies only to the BUTTONS component. Each Carousel card can have a maximum of two buttons.', 'type' => 'array', 'items' => [ 'description' => 'The button object.', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'The button text.', 'type' => 'string', 'required' => false, 'example' => 'Call me'], 'Type' => ['title' => '', 'description' => 'The button type.'."\n" ."\n" .'- **PHONE_NUMBER**: phone call button'."\n" ."\n" .'- **URL**: web button'."\n" ."\n" .'- **QUICK_REPLY**: quick reply button', 'type' => 'string', 'required' => true, 'example' => 'PHONE_NUMBER'], 'Url' => ['title' => '', 'description' => 'The URL to visit when the button is clicked.', 'type' => 'string', 'example' => 'https://alibaba.com/xx'."\n", 'required' => false], 'UrlType' => ['title' => '', 'description' => 'The URL type.'."\n" ."\n" .'- **static**: static'."\n" ."\n" .'- **dynamic**: dynamic', 'type' => 'string', 'example' => 'static', 'required' => false], 'PhoneNumber' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '+861368893****'."\n", 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'Language', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The template language. For detailed language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'en'], ], [ 'name' => 'Example', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The examples for creating the template.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'The examples for creating the template.', 'type' => 'string', 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], 'example' => '', ], ], [ 'name' => 'CustWabaId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ISV customer WabaId.'."\n" ."\n" .'> Deprecated parameter. Use CustSpaceId instead.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '65921621816****'], ], [ 'name' => 'IsvCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ISV verification code used to verify whether the RAM user is authorized by the ISV.', 'type' => 'string', 'example' => 'ksiekdki39ksks93939', 'required' => false], ], [ 'name' => 'TemplateCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The message template code.', 'type' => 'string', 'required' => false, 'example' => '8472929283883'], ], [ 'name' => 'CustSpaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The SpaceId of the ISV sub-customer or the instance ID of a direct customer.', 'type' => 'string', 'docRequired' => true, 'example' => '28251486512358****', 'required' => true], ], [ 'name' => 'Category', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The templatetype cannot be modified.', 'type' => 'string', 'example' => 'text', 'required' => false], ], [ 'name' => 'TemplateType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The templatetype.'."\n" ."\n" .'- **WHATSAPP**', 'type' => 'string', 'example' => 'WHATSAPP', 'required' => false], ], [ 'name' => 'MessageSendTtlSeconds', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The validity period for sending template messages in WhatsApp.'."\n" .'- AUTHENTICATION: valid values are 30 to 900. '."\n" .'- UTILITY: valid values are 30 to 43200.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2592000', 'minimum' => '30', 'example' => '120', 'required' => false], ], [ 'name' => 'TemplateName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'required' => false, 'example' => 'test_name'], ], [ 'name' => 'CategoryChangePaused', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to pause sending when a Utility template is changed to Marketing type.', 'type' => 'boolean', 'required' => false, 'example' => '120'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'], 'Code' => ['title' => '', 'description' => 'The request status code.'."\n" ."\n" .'- OK indicates the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'None'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'TemplateCode' => ['title' => '', 'description' => 'The template code.', 'type' => 'string', 'example' => '8472929283883'], 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => 'hello_whatsapp'], ], 'title' => '', 'example' => '', ], 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'title' => 'Modify a chatApp template', 'summary' => 'Modifies a message template. Only templates that have not been reviewed or that failed the review can be modified.', 'description' => '### QPS limit'."\n" .'The single-user QPS limit for this operation is 50 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as needed.'."\n" ."\n" .'### Status changes'."\n" .'Changes to the template status and quality can be monitored through MNS or HTTP. For more information, see [Receipt messages](~~421545~~).', 'changeSet' => [ ['createdAt' => '2025-06-11T13:05:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-26T05:51:50.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-02T02:33:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-06-21T01:24:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-22T08:58:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-10-19T06:41:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-17T12:01:01.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T11:30:26.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-05-08T11:38:22.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T12:02:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-17T10:02:19.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-29T08:00:04.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyChatappTemplate'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ModifyChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"None\\",\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"8472929283883\\",\\n \\"TemplateName\\": \\"hello_whatsapp\\"\\n },\\n \\"AccessDeniedDetail\\": \\"None\\"\\n}","type":"json"}]', ], 'ModifyChatappTemplateProperties' => [ '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' => 'The template code.', 'type' => 'string', 'required' => true, 'example' => '929938***', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The template language. For more information about language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'zh_CN', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'query', 'schema' => ['description' => 'The templatetype.'."\n" ."\n" .'- **WHATSAPP**', 'type' => 'string', 'required' => true, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-idk***', 'title' => ''], ], [ 'name' => 'CategoryChangePaused', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to block sending after the Utility template category is changed.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'AllowSend', 'in' => 'query', 'schema' => ['description' => 'Specifies whether sending is allowed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '399s88-***'."\n", 'title' => ''], 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify template properties', 'summary' => 'Modifies some properties of a template.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], '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"}]', ], 'ModifyFlow' => [ 'summary' => 'Modifies the basic information of 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' => ['description' => 'The name of the flow.', 'type' => 'string', 'required' => true, 'example' => 'Flow-**001', 'title' => ''], ], [ 'name' => 'Categories', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The folder.', 'type' => 'array', 'items' => [ 'description' => 'The flow folder information.'."\n" ."\n" .'Valid values:'."\n" .'- CUSTOMER_SUPPORT'."\n" .'- OTHER'."\n" .'- SIGN_IN'."\n" .'- SIGN_UP'."\n" .'- APPOINTMENT_BOOKING'."\n" .'- LEAD_GENERATION'."\n" .'- SURVEY'."\n" .'- CONTACT_US', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => '["SIGN_UP"]', 'title' => '', ], 'required' => true, 'example' => '', 'title' => '', ], ], [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The ID of the flow.', 'type' => 'string', 'required' => false, 'example' => '21231232312', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-1sdkjwen2', 'title' => ''], ], [ 'name' => 'EndpointUri', 'in' => 'query', 'schema' => ['description' => 'The URL of the WA Flow Endpoint', 'type' => 'string', 'required' => false, 'example' => 'http://www.***.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response。', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1612C226-E271-4CFE-9F18-4066D******', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'Flow ID。', 'type' => 'string', 'example' => '92675332812643****'."\n", 'title' => ''], 'EndpointUri' => ['description' => 'The URL of the WA Flow Endpoint', 'type' => 'string', 'example' => 'http://www.abc.com', 'title' => ''], 'Categories' => [ 'description' => 'The flow folder.', 'type' => 'array', 'items' => ['description' => 'The flow folder.', 'type' => 'string', 'example' => 'SIGN_UP', 'title' => ''], 'example' => '', 'title' => '', ], 'FlowName' => ['description' => 'The name of the flow.', 'type' => 'string', 'example' => 'flow_001', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response code. OK indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Modify flow basic information', 'description' => 'The China Short Message Service (China SMS) API has a single-user QPS limit of 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation appropriately.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:ModifyFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'ModifyPhoneBusinessProfile' => [ '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 ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'Address', 'in' => 'query', 'schema' => ['description' => 'The address.', 'type' => 'string', 'required' => false, 'example' => 'Sichuan', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Vertical', 'in' => 'query', 'schema' => [ 'description' => 'The industry vertical.', 'enumValueTitles' => [ 'RETAIL' => 'retail.', 'TRAVEL' => 'travel.', 'PROF_SERVICES' => 'professional services.', 'APPAREL' => 'apparel.', 'GOVT' => 'government.', 'ENTERTAIN' => 'entertainment.', 'GROCERY' => 'grocery.', 'HOTEL' => 'hotel.', 'OTHER' => 'other.', 'AUTO' => 'automotive.', 'FINANCE' => 'finance.', 'BEAUTY' => 'beauty.', 'EDU' => 'education.', 'EVENT_PLAN' => 'event planning.', 'NONPROFIT' => 'nonprofit.', 'RESTAURANT' => 'restaurant.', 'HEALTH' => 'health.', ], 'type' => 'string', 'required' => false, 'example' => 'OTHER', 'title' => '', ], ], [ 'name' => 'Email', 'in' => 'query', 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => 'aa@aliyun.com', 'title' => ''], ], [ 'name' => 'ProfilePictureUrl', 'in' => 'query', 'schema' => ['description' => 'The profile picture URL.', 'type' => 'string', 'required' => false, 'example' => 'http://a.img', 'title' => ''], ], [ 'name' => 'Websites', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The websites.', 'type' => 'array', 'items' => ['description' => 'The website address.', 'type' => 'string', 'required' => false, 'example' => 'https://alibaba.com', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], ], [ 'name' => 'About', 'in' => 'query', 'schema' => ['description' => 'The about information.', 'type' => 'string', 'required' => false, 'example' => 'business profile', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The prompt message. A value is returned when an exception occurs.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify phone number commercial information', 'summary' => 'Modifies the commercial information of a phone number.', 'description' => 'The China Message Service (China) API has a single-user QPS limit of 10 calls per second. If this limit is exceeded, throttling is triggered, which may affect your business. Manage your calls appropriately.', 'changeSet' => [ ['createdAt' => '2024-04-10T09:38:08.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:30:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneBusinessProfile'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ModifyPhoneBusinessProfile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\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' => ['type' => 'string', 'required' => true, 'example' => '[{"id":1}]', 'description' => '', 'title' => ''], ], [ 'name' => 'LinkExistGroups', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '[{"id":1}]', 'description' => '', 'title' => ''], ], [ 'name' => 'LinkNewGroups', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => '[{"groupName":"aaa"}]', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:MoveContactToGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'OfflineFlowVersion' => [ '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' => 'The code of the flow. View the code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'."\n"], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the flow. View the version on the orchestration canvas in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the flow. View the remarks in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '不再需要此版本'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. Default value: ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error description.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Offline Flow Version', 'summary' => 'Unpublishes a flow version.', 'description' => '- You can call this operation to unpublish a flow version. You can also manually unpublish a flow version in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) by clicking the flow name to open the orchestration canvas.'."\n" ."\n" .'- Before calling this operation, make sure that the flow is published.'."\n" ."\n" .'- If a flow is not published, you can publish it manually from the orchestration canvas in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder), or by calling the [OnlineFlowVersion](~~2937203~~) operation.'."\n" ."\n" .'- After a flow version is unpublished, the orchestrated flow stops running. This may affect your business. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:OfflineFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'OnlineFlowVersion' => [ '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' => 'The flow code. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'f4912c16943b4dfba44bd6fedacf****'], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. In the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder), click the flow name to open the orchestration canvas and view the flow version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the flow. You can view the remarks in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '通过API触发下发验证模板'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'Business extension information. The default value is an empty object.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Online Flow Version', 'summary' => 'Publishes a flow version.', 'description' => '- You can call this operation to publish a flow version. You can also manually publish a flow version in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) by clicking the flow name to open the orchestration canvas.'."\n" ."\n" .'- Before you call this operation, make sure that you have created a flow and attached it to a phone number or a business account ID.'."\n" ."\n" .'- If you have not created a flow, you can create one manually in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) and attach a phone number or business account ID. Alternatively, you can call the [CreateChatFlow](~~2937204~~) and [FlowBindPhone](~~2937190~~) operations to create a flow and attach a phone number or business account ID.'."\n" ."\n" .'- After a flow with a non-manual trigger is published, it is triggered when the attached phone number or business account sends a message to the business. If your flow contains components that incur fees, such as message sending or function invocations, make sure you understand the billing methods and pricing of the related products before you call this operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:OnlineFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'OpenChatappService' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'example' => '3D2FFEE6-368D-532D-87AA-F45B02DD28B7', 'title' => ''], 'Code' => ['type' => 'string', 'description' => '', 'example' => 'OK', 'title' => ''], 'Message' => ['type' => 'string', 'description' => '', 'example' => 'success', 'title' => ''], 'OpenStatus' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:OpenChatappService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3D2FFEE6-368D-532D-87AA-F45B02DD28B7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"OpenStatus\\": true\\n}","type":"json"}]', ], 'PauseMarketingFLow' => [ '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' => ['type' => 'string', 'required' => false, 'example' => '439859845**234', 'description' => '', 'title' => ''], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => false, 'example' => 'N/A', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:PauseMarketingFLow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'PublishFlow' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201007', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The Flow ID, which is the FlowId returned by the [CreateFlow](~~2638742~~) operation when you create a WhatsApp Flow.', 'type' => 'string', 'required' => true, 'example' => '333993838***', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)'."\n" .'page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DAC72B08-3327-33EF-BEDC-8EC3E83A6575'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Publish a flow', 'summary' => 'Publishes a Flow.', 'description' => '- Before calling this operation, make sure that you have a successfully created WhatsApp Flow.'."\n" ."\n" .'- If you do not have a successfully created WhatsApp Flow, create one by calling the [CreateFlow](~~2638742~~) operation.'."\n" ."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as needed.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:PublishFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"DAC72B08-3327-33EF-BEDC-8EC3E83A6575\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'QueryChatappBindWaba' => [ 'summary' => 'Queries the WhatsApp Business Account (WABA) that is bound to a customer account.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '159851', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => '293483****49493', 'title' => ''], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'The ISV verification code, used to verify that the sub-account is authorized.', 'type' => 'string', 'required' => false, 'example' => 'aksik93kdkkxmwol9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'AuthInternationalRateEligibility' => ['description' => 'Details about the WABA account.', 'type' => 'object', 'example' => '', 'title' => ''], 'MarketingMessageLiteStatus' => ['description' => 'The MML status.', 'type' => 'string', 'example' => 'Y', 'title' => ''], 'BusinessName' => ['description' => 'The Business platform name.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'Currency' => ['description' => 'The currency.', 'type' => 'string', 'example' => 'USD', 'title' => ''], 'Id' => ['description' => 'The WABA account ID.', 'type' => 'string', 'example' => '20393988393993***', 'title' => ''], 'AccountReviewStatus' => ['description' => 'The account review status. Valid values:'."\n" ."\n" .'- `PENDING`: The account is under review.'."\n" ."\n" .'- `APPROVED`: The account is approved.'."\n" ."\n" .'- `REJECTED`: The account is rejected.'."\n" ."\n" .'- `DISABLED`: The account is disabled.', 'type' => 'string', 'example' => 'APPROVED', 'title' => ''], 'MessageTemplateNamespace' => ['description' => 'The template namespace.', 'type' => 'string', 'example' => '93e6b26e_8a67_4163_a093_ebfe645a66b0', 'title' => ''], 'BusinessId' => ['description' => 'The Business platform ID.', 'type' => 'string', 'example' => '19293988***', 'title' => ''], 'Name' => ['description' => 'The WABA account name.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'PrimaryBusinessLocation' => ['description' => 'The international rate capability qualification.', 'type' => 'string', 'example' => '"start_time":1721952000', 'title' => ''], 'IsOnBizApp' => ['type' => 'string', 'example' => 'N', 'description' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of `OK` indicates the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful:'."\n" ."\n" .'- `true`: The request was successful.'."\n" ."\n" .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\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 \\"IsOnBizApp\\": \\"N\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'QueryChatappBindWaba', 'description' => 'This API has a per-user QPS limit of 10. Calls that exceed this limit are subject to flow control, which may impact your business. Make API calls at a reasonable rate.', 'changeSet' => [ ['createdAt' => '2025-03-26T05:51:51.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T11:30:29.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatappBindWaba'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryChatappBindWaba', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'QueryChatappPhoneNumbers' => [ 'summary' => 'Queries all phone numbers used for sending messages and their statuses for a customer.', '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 verification code of the Independent Software Vendor (ISV). This code is used to verify if the user is authorized by the ISV.', 'type' => 'string', 'required' => false, 'example' => 'aksik93kdkkxmwol9****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => ['description' => 'The status of the phone number.', 'type' => 'string', 'required' => false, 'example' => 'VERIFIED', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'PhoneNumbers' => [ 'description' => 'The list of phone numbers.', 'type' => 'array', 'items' => [ 'description' => 'The data structure.', 'type' => 'object', 'properties' => [ 'VerifiedName' => ['description' => 'The name used for the request.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'Status' => [ 'description' => 'The status of the phone number.', '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', ], 'type' => 'string', 'example' => 'CONNECTED', 'title' => '', ], 'UpQueue' => ['description' => 'The queue for mobile originated messages.', 'type' => 'string', 'example' => 'Alicom-Queue-****-ChatAppInbound', 'title' => ''], 'NameStatus' => ['description' => 'The status of the name.', 'type' => 'string', 'example' => 'Approval', 'title' => ''], 'MessagingLimitTier' => [ 'description' => 'The messaging limit tier of the phone number.', 'enumValueTitles' => ['TIER_100K' => '100,000', 'TIER_UNLIMITED' => 'Unlimited', 'TIER_250' => '250', 'TIER_1K' => '1,000', 'TIER_50' => '50', 'TIER_10K' => '10,000'], 'type' => 'string', 'example' => 'TIER_10K', 'title' => '', ], 'StatusCallbackUrl' => ['description' => 'The callback URL for delivery receipts.', 'type' => 'string', 'example' => 'https://ali.com/status', 'title' => ''], 'QualityRating' => [ 'description' => 'The quality rating of the phone number.', 'enumValueTitles' => ['RED' => 'Low quality', 'YELLOW' => 'Medium quality', 'UNKNOWN' => 'Unknown', 'GREEN' => 'High quality'], 'type' => 'string', 'example' => 'GREEN', 'title' => '', ], 'CodeVerificationStatus' => [ 'description' => 'The verification status of the phone number.', 'enumValueTitles' => ['REVOKED' => 'Revoked', 'MORE_INFORMATION_REQUESTED' => 'More information is requested', 'VERIFIED' => 'Verified', 'REJECTED' => 'Rejected'], 'type' => 'string', 'example' => 'VERIFIED', 'title' => '', ], 'NewNameStatus' => ['description' => 'The review status of the new name.', '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' => '', 'description' => '', 'title' => '', ], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '861380000****', 'title' => ''], 'StatusQueue' => ['description' => 'The queue for delivery receipts of mobile terminated messages.', 'type' => 'string', 'example' => 'Alicom-Queue-****-ChatAppStatus', 'title' => ''], 'IsOfficial' => ['type' => 'string', 'example' => 'N', 'description' => '', 'title' => ''], 'UpCallbackUrl' => ['description' => 'The callback URL for mobile originated messages.', 'type' => 'string', 'example' => 'https://ali.com/inbound', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', 'title' => '', ], 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => [ 'description' => 'The returned message.', 'enumValueTitles' => [], 'type' => 'string', 'example' => 'SUCCESS', 'title' => '', ], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'title' => 'QueryChatappPhoneNumbers', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-04-07T06:36:23.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-26T05:51:52.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:30:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2022-12-21T02:06:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatappPhoneNumbers'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:QueryChatappPhoneNumbers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'QueryInstance' => [ 'summary' => 'Gets the details of a specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '205979', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '9293938****', 'default' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The detailed reason for access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '29kskkd******', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'CountryId' => ['description' => 'The country ID.'."\n" ."\n" .'> For a list of country codes, see [Country codes](~~608210~~).', 'type' => 'string', 'example' => '1', 'title' => ''], 'ContactMail' => ['description' => 'The contact email address.', 'type' => 'string', 'example' => '1@alibaba.com', 'title' => ''], 'CustType' => ['description' => 'The customer type.', 'type' => 'string', 'example' => '01', 'title' => ''], 'ResourceRegionId' => ['description' => 'The region ID of the resource.', 'type' => 'string', 'example' => '1', 'title' => ''], 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => '111', 'title' => ''], 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'string', 'example' => '293939*****', 'title' => ''], 'OfficeAddress' => ['description' => 'The office address.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'SubmitTime' => ['description' => 'The submission time.', 'type' => 'string', 'example' => '140092992', 'title' => ''], 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'viber_ins', 'title' => ''], 'IsvTerms' => ['description' => 'The ISV terms.', 'type' => 'string', 'example' => 'https://alibaba.com/1.pdf', 'title' => ''], 'FacebookBmId' => ['description' => 'The Facebook Business Manager ID.', 'type' => 'string', 'example' => '39929****', 'title' => ''], 'InstanceDescription' => ['description' => 'The description of the instance.', 'type' => 'string', 'example' => 'ins', 'title' => ''], 'ChannelType' => ['description' => 'The channel type.', 'type' => 'string', 'example' => 'VIBER', 'title' => ''], ], 'example' => '', 'description' => 'The data object returned on a successful request.', 'title' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- `OK` indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error code list](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'QueryInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"NULL\\",\\n \\"RequestId\\": \\"29kskkd******\\",\\n \\"Data\\": {\\n \\"CountryId\\": \\"1\\",\\n \\"ContactMail\\": \\"1@alibaba.com\\",\\n \\"CustType\\": \\"01\\",\\n \\"ResourceRegionId\\": \\"1\\",\\n \\"ResourceGroupId\\": \\"111\\",\\n \\"InstanceId\\": \\"293939*****\\",\\n \\"OfficeAddress\\": \\"example\\",\\n \\"SubmitTime\\": \\"140092992\\",\\n \\"InstanceName\\": \\"viber_ins\\",\\n \\"IsvTerms\\": \\"https://alibaba.com/1.pdf\\",\\n \\"FacebookBmId\\": \\"39929****\\",\\n \\"InstanceDescription\\": \\"ins\\",\\n \\"ChannelType\\": \\"VIBER\\"\\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' => ['type' => 'string', 'required' => false, 'example' => 'erer-retreerew**', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'success', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'QueryPhoneBusinessProfile' => [ 'summary' => 'Queries the business information of a phone number.', '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 ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Vertical' => ['description' => 'The industry.', 'type' => 'string', 'example' => 'Retail', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Description', 'title' => ''], 'Email' => ['description' => 'The email address.', 'type' => 'string', 'example' => 'example@aliyun.com', 'title' => ''], 'Address' => ['description' => 'The address.', 'type' => 'string', 'example' => 'Changsha', 'title' => ''], 'ProfilePictureUrl' => ['description' => 'The profile picture URL.', 'type' => 'string', 'example' => 'https://example.img', 'title' => ''], 'Websites' => [ 'description' => 'The websites.', 'type' => 'array', 'items' => ['description' => 'The website URL.', 'type' => 'string', 'example' => 'https://alibaba.com', 'title' => ''], 'example' => '', 'title' => '', ], 'About' => ['description' => 'The about information.', 'type' => 'string', 'example' => 'business profile', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query phone number business information', 'description' => 'The queries per second (QPS) limit for this operation is 10 per user. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation at an appropriate frequency.', 'changeSet' => [ ['createdAt' => '2024-04-10T09:38:08.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:30:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPhoneBusinessProfile'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryPhoneBusinessProfile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Vertical\\": \\"Retail\\",\\n \\"Description\\": \\"Description\\",\\n \\"Email\\": \\"example@aliyun.com\\",\\n \\"Address\\": \\"Changsha\\",\\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"}]', ], '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 ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849493****', 'title' => ''], ], [ 'name' => 'WabaId', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The ID of the WhatsApp Business Account (WABA).', 'type' => 'string', 'required' => true, 'example' => '29384882****'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => [ 'description' => 'The business information about the WABA.', 'type' => 'object', 'properties' => [ 'Vertical' => ['description' => 'The industry.', 'type' => 'string', 'example' => 'Retail', 'deprecated' => true, 'title' => ''], 'VerificationStatus' => ['description' => 'The verification status.', 'type' => 'string', 'example' => 'verified', 'title' => ''], 'BusinessName' => ['description' => 'The Business Manager name.', 'type' => 'string', 'example' => 'Alibaba', 'title' => ''], 'BusinessId' => ['description' => 'The Business Manager ID.', 'type' => 'string', 'example' => '19288282****', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The HTTP status code returned.'."\n" ."\n" .'- A value of OK indicates that the call is successful.'."\n" ."\n" .'- Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**'."\n" ."\n" .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Data\\": {\\n \\"Vertical\\": \\"Retail\\",\\n \\"VerificationStatus\\": \\"verified\\",\\n \\"BusinessName\\": \\"Alibaba\\",\\n \\"BusinessId\\": \\"19288282****\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'QueryWabaBusinessInfo', 'description' => 'This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-02-26T09:22:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:30:30.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '1', 'countWindow' => 20, 'regionId' => '*', 'api' => 'QueryWabaBusinessInfo'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryWabaBusinessInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], ], 'ReadChatFlow' => [ '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' => 'The flow code. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: The operation is successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Get Flow Details', 'summary' => 'Retrieves the details of a flow.', 'description' => '- You can call this API operation to retrieve the details of a flow. You can also view the flow details in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before you call this operation, make sure that you have created a flow.'."\n" ."\n" .'- If you have not created a flow, you can create one in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) or by calling the [CreateChatFlow](~~2937204~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ReadChatFlowLogSetting' => [ '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' => 'The code of the flow. You can find the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" ."\n" .'- true: The operation is successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'View Process Log Settings', 'summary' => 'Views the log settings for a flow.', 'description' => '- Before you call this operation, ensure that log settings are configured for the flow.'."\n" ."\n" .'- If log settings are not configured for the flow, call the [CreateChatFlowLogSetting](~~2937211~~) operation to configure them.'."\n" ."\n" .'- You can use the unique ID returned by this operation to call the [UpdateChatFlowLogSetting](~~2937210~~) operation to update the log settings.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'ReadFlowVersion' => [ 'summary' => 'Retrieves a 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' => 'The flow code. You can view the flow code on the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page.', 'type' => 'string', 'required' => false, 'example' => '9ccc41**************************', 'title' => ''], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The flow version. You can click a flow name on the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page to go to the canvas orchestration page and view the flow version, or call [ListFlowVersion](~~2937202~~) to retrieve the flow version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The flow version status. Valid values:'."\n" .'- DRAFT: draft.'."\n" .'- DELETED: deleted.'."\n" .'- ONLINE: online.'."\n" .'- OFFLINE: offline.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'DRAFT', 'title' => '', ], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => ['description' => 'The business tenant code. Default value: ALICOM_OPAAS.', 'type' => 'string', 'required' => false, 'example' => 'ALICOM_OPAAS', 'default' => 'ALICOM_OPAAS', 'title' => ''], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. Default value: an empty collection.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The response content.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: successful.'."\n" ."\n" .'- false: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Get flow version', 'description' => '- You can call this operation to query a flow version. You can also click a flow name on the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page to go to the canvas orchestration page and view the flow version.'."\n" ."\n" .'- Before calling this operation, make sure that you have successfully created a flow.'."\n" ."\n" .'- If you do not have a successfully created flow, you can manually create a flow on the [flow editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page or create a flow by calling [CreateChatFlow](~~2937204~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'RemoveContactById' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '46546546546**', 'description' => '', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '3456456346**', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:RemoveContactById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'RequestWhatsappConversionApi' => [ 'summary' => 'Sends a request to the WhatsApp Conversions 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' => 'The PageId of Meta.', 'type' => 'string', 'required' => true, 'example' => '1939848838', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the customer.', 'type' => 'string', 'required' => true, 'example' => '929399382', 'title' => ''], ], [ 'name' => 'RequestData', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The request data.', 'type' => 'array', 'items' => [ 'description' => 'The request data.', 'type' => 'object', 'properties' => [ 'DataProcessingOptionsState' => ['description' => 'Required in some cases. (See the notes below for details.)'."\n" .'The state you want to associate with this data processing option. Currently accepted values are 1000 (representing California) or 0 (requesting that we geolocate this event).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26', 'title' => ''], 'UserData' => [ 'description' => 'A map that contains customer information data.', 'type' => 'object', 'required' => true, 'additionalProperties' => ['description' => 'data', 'type' => 'any', 'example' => '{"currency":"USD", "value": 1}', 'title' => ''], 'example' => '', 'title' => '', ], 'EventName' => ['description' => '- The name of a standard event or custom event. This field is used to deduplicate events sent by a website (through Meta Pixel), an app (through the SDK or App Events API), and the Conversions API. The event_id parameter is also used for deduplication.'."\n" ."\n" .'- For the same customer action, the event from the browser or app should match the event_name from the server event. If a match is found between events sent within 48 hours, only the first event is considered. If server and browser/app events are received at approximately the same time (within 5 minutes of each other), the browser/app event takes priority. Learn more about deduplicating Pixel events and server events.', 'type' => 'string', 'required' => true, 'example' => 'Purchase', 'title' => ''], 'OptOut' => ['description' => 'A flag that indicates this event should not be used for ad delivery optimization. When set to true, the event can only be used for attribution.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'AppData' => [ 'description' => 'Required parameters for app events.'."\n" ."\n" .'These parameters are used to share app data and device information with the Conversions API.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'data', 'type' => 'any', 'example' => '{}', 'title' => ''], 'example' => '', 'title' => '', ], 'EventTime' => ['description' => 'A Unix timestamp in seconds indicating when the event actually occurred. The specified time may be earlier than the time you send the event to Facebook. This is intended for batch processing and server performance optimization. You must send the date in Greenwich Mean Time (GMT) time zone format.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1709201870', 'title' => ''], 'ExtInfo' => [ 'description' => 'Required parameters for app events.'."\n" ."\n" .'Extended device information, such as the width and height of the screen. This parameter is an array with values separated by commas. When using extinfo, all values are required and must be arranged in the following index order. If a value is missing, use an empty string as a placeholder.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'data', 'type' => 'any', 'example' => '{}', 'title' => ''], 'example' => '', 'title' => '', ], 'CustomData' => [ 'description' => 'A map that contains additional business data for the event.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'data', 'type' => 'any', 'example' => '{}', 'title' => ''], 'example' => '', 'title' => '', ], 'EventId' => ['description' => 'This ID can be any unique string chosen by the advertiser. The event_name and event_id parameters are used to deduplicate events sent by a website (through Meta Pixel), an app (through the SDK or App Events API), and the Conversions API. Although event_id is marked as optional, we recommend that you use this parameter for deduplication.', 'type' => 'string', 'required' => false, 'example' => '20029399299', 'title' => ''], 'DataProcessingOptions' => [ 'description' => 'The processing options you want to enable for a specific event. For Limited Data Use, the currently accepted value is LDU. You can send an empty array to explicitly specify that the event must not be processed with Limited Data Use restrictions.', 'type' => 'array', 'items' => ['description' => 'data', 'type' => 'string', 'required' => false, 'example' => ' [] ', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], 'MessagingChannel' => ['description' => 'The source. Fixed value: whatsapp.', 'type' => 'string', 'required' => false, 'example' => 'whatsapp', 'title' => ''], 'ActionSource' => ['description' => 'Specifies where the conversion occurred. Knowing where the event occurred helps ensure that ads are delivered to the correct audience. By using the Conversions API, you agree that the action_source parameter is accurate to the best of your knowledge.'."\n" ."\n\n" .'The values you can send in the action_source field are as follows:'."\n" ."\n\n" .'- email: The conversion occurred through email.'."\n" .'- website: The conversion was made on a website.'."\n" .'- app: The conversion was made on a shift application.'."\n" .'- phone_call: The conversion was made over the phone.'."\n" .'- chat: The conversion was made through a messaging app, SMS, or online messaging feature.'."\n" .'- physical_store: The conversion was made in person at a physical store entity.'."\n" .'- system_generated: The conversion occurred automatically, such as a subscribe renewal with Settings for monthly automatic payment.'."\n" .'- other: The conversion was made through a method not listed in this topic.'."\n" ."\n" .'Note: All action source values support ads measurement and custom audience creation. All action sources except physical_store support ads optimization.', 'type' => 'string', 'required' => true, 'example' => 'business_messaging', 'title' => ''], 'DataProcessingOptionsCountry' => ['description' => 'Required if you send LDU under data_processing_options.'."\n" .'The country you want to associate with this data processing option. Currently accepted values are 1 (representing the United States) or 0 (requesting that we geolocate this event).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], 'EventSourceUrl' => ['description' => 'The browser URL where the event occurred. The URL must start with http:// or https:// and should match the verified domain.', 'type' => 'string', 'required' => false, 'example' => 'http://alibaba.com', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**'."\n" .'- **false**.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Request whatsApp conversions API', 'description' => 'The China-specific QPS limit for a single user of this API operation is 100 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation as needed.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'cams:RequestWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SendChatappMassMessage' => [ 'summary' => 'Sends bulk messages to multiple recipients.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '149595', 'abilityTreeNodes' => ['FEATUREcamsU2M7I2'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **whatsapp**'."\n" ."\n" .'- **messenger**'."\n" ."\n" .'- **instagram**'."\n" ."\n" .''."\n" ."\n" .'- **viber**'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'example' => 'whatsapp', 'title' => ''], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['description' => 'The template code. View the template code on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Template Design** page.', 'type' => 'string', 'required' => false, 'example' => '1119***************', 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The language. For language codes, see [Language codes](~~463420~~).', 'type' => 'string', 'required' => true, 'example' => 'en', 'title' => ''], ], [ 'name' => 'From', 'in' => 'query', 'schema' => ['description' => 'The sender\'s number.'."\n" ."\n" .'- If ChannelType is **whatsapp**, this is the phone number registered and bound with WhatsApp. View the number on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **WABA Management** > **Phone Number Management** page.'."\n" ."\n" .'- If ChannelType is **messenger**, this is the Page ID. View the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Facebook Homepage** page.'."\n" ."\n" .'- If ChannelType is **instagram**, this is the Instagram professional account ID. View the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Professional Account** page.'."\n" ."\n" .''."\n" ."\n" .'- If ChannelType is **viber**, this is the Viber service ID. View the ID on the [**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Service Number Management **page.'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'example' => '861387777****', 'title' => ''], ], [ 'name' => 'CustWabaId', 'in' => 'query', 'schema' => ['description' => 'The WhatsApp Business Account (WABA) ID of the Independent Software Vendor (ISV) customer. This is a deprecated parameter. Use CustSpaceId instead, which is the direct customer\'s instance ID. View the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'cams-8c8*********'."\n", 'title' => ''], ], [ 'name' => 'FallBackId', 'in' => 'query', 'schema' => ['description' => 'The fallback policy ID. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com).View the policy ID on the [**Fallback Policy**](https://chatapp.console.alibabacloud.com/FallbackStrategy) page.', 'type' => 'string', 'required' => false, 'example' => 'S0****', 'title' => ''], ], [ 'name' => 'FallBackContent', 'in' => 'query', 'schema' => ['description' => 'The custom fallback content. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com).', 'type' => 'string', 'required' => false, 'example' => 'Fallback SMS', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'The custom task ID.', 'type' => 'string', 'required' => false, 'example' => '10000****', 'title' => ''], ], [ 'name' => 'SenderList', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'A list of recipients.', 'type' => 'array', 'items' => [ 'description' => 'The phone number of the recipient.', 'type' => 'object', 'properties' => [ 'TemplateParams' => [ 'title' => '', 'description' => 'The collection of template parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'Template parameter as a Key-Value pair. The Key is the parameter name, and the Value is the parameter\'s value.', 'type' => 'string', 'example' => '{'."\n" .' "param1": "value1",'."\n" .' "param2": "value2"'."\n" .'}', 'title' => ''], 'example' => '', ], 'FlowAction' => [ 'title' => '', 'description' => 'The Flow message object.', 'type' => 'object', 'properties' => [ 'FlowActionData' => [ 'title' => '', 'description' => 'A collection of default flow parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'Default flow parameter as a Key-Value pair. The Key is the parameter name, and the Value is the parameter\'s value.', 'type' => 'any', 'example' => '{'."\n" .' "name": "name"'."\n" .'}', 'title' => ''], 'example' => '', ], 'FlowToken' => ['description' => 'The custom flow token information.', 'type' => 'string', 'required' => false, 'example' => 'kde****', 'title' => ''], ], 'required' => false, 'example' => '', ], 'Payload' => [ 'title' => '', 'description' => 'The list of payloads for the buttons.', 'type' => 'array', 'items' => ['description' => 'The payload for a button.', 'type' => 'string', 'required' => false, 'example' => 'payloadtext', 'title' => ''], 'required' => false, 'maxItems' => 3, 'minItems' => 0, 'example' => '', ], 'To' => ['description' => 'The recipient\'s number.'."\n" ."\n" .'- If ChannelType is **whatsapp**, this is the recipient\'s phone number.'."\n" ."\n" .'- If ChannelType is **messenger**, this is a Page-Scoped User ID generated when a user interacts with a Facebook page.'."\n" ."\n" .'- If ChannelType is **instagram**, this is an Instagram User ID generated when a user interacts with an Instagram business or creator account.'."\n" ."\n" .''."\n" ."\n" .'- If ChannelType is **viber**, this is the recipient\'s phone number.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => '861386666****'."\n", 'title' => ''], 'ProductAction' => [ 'title' => '', 'description' => 'Product information. This parameter is only for WhatsApp channels and refers to product information uploaded to Meta.', 'type' => 'object', 'properties' => [ 'ThumbnailProductRetailerId' => ['description' => 'The product catalog ID. Get it by calling the [ListProductCatalog](~~2539783~~) API.', 'type' => 'string', 'required' => false, 'example' => 'skkks99****', 'title' => ''], 'Sections' => [ 'title' => '', 'description' => 'The list of product categories. You can have up to 10 categories and 30 products.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The product category.', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'The category name. View it on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Catalog Management** > **Product Management** page or get it by calling the [ListProduct](~~2557786~~) API.', 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], 'ProductItems' => [ 'title' => '', 'description' => 'The list of product information.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The product information.', 'type' => 'object', 'properties' => [ 'ProductRetailerId' => ['description' => 'The product ID. View it on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Catalog Management** > **Product Management** page or get it by calling the [ListProduct](~~2557786~~) API.', 'type' => 'string', 'required' => false, 'example' => 'ksi3****', 'title' => ''], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'title' => '', ], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => 'ISV verification code, used to verify if the user is authorized by an ISV. This parameter is deprecated.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'skdi3kksloslikd****', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer, or the instance ID for a direct customer. View it on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-8c8*********', 'title' => ''], ], [ 'name' => 'Ttl', 'in' => 'query', 'schema' => ['description' => 'The timeout period for sending a Viber message. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com).Unit: seconds. Valid values: 30 to 1209600.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '46', 'title' => ''], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => ['description' => 'The Viber message type. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com). Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **promotion**: marketing messages.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- **transaction**: notification messages.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => 'promotion', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => ['description' => 'A custom tag for a Viber message.', 'type' => 'string', 'required' => false, 'example' => 'Tag'."\n", 'title' => ''], ], [ 'name' => 'FallBackDuration', 'in' => 'query', 'schema' => ['description' => 'The time to trigger a fallback. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com).If a delivery receipt is not returned within the specified time, a fallback is triggered. If you leave this parameter empty, the fallback is not determined by time. A fallback is triggered only when the message fails to be sent or a failed status report is received. Unit: seconds. Minimum value: 60. Maximum value: 43200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], ], [ 'name' => 'FallBackRule', 'in' => 'query', 'schema' => ['description' => 'The fallback rule. This parameter is for the international site (alibabacloud.com). You can ignore it for the China site (aliyun.com). Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **undelivered**: A fallback is triggered if the message cannot be delivered to the recipient. This rule requires that the template and parameters pass verification before sending. The rule does not apply if the message is blocked from sending, for example, due to a blacklisted template or phone number. This is the default rule if this parameter is empty.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- **sentFailed**: A fallback is triggered if the template, template variables, or other parameters fail verification. Only the channelType, type, messageType, to, and the existence of the from parameter are strictly verified.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => 'undelivered', 'title' => ''], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['description' => 'The template name. View the template name on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Template Design** page.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], 'GroupMessageId' => ['description' => 'The bulk message ID.', 'type' => 'string', 'example' => '890000010002****', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SendChatappMassMessage', 'description' => '- You can call this operation to send messages in bulk. You can also send messages in the console. To do so, go to the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList), click a channel, and then choose **Message Sending**.'."\n" ."\n" .'- Before you call this operation, make sure that you have created a channel and have an approved template.'."\n" ."\n" .'- For a WhatsApp channel, you must [register and bind a WABA](t2012827.xdita#) and [add a phone number](t2012827.xdita#).'."\n" ."\n" .'- For a Messenger channel, you must [connect to a Facebook Page](t2746072.xdita#).'."\n" ."\n" .'- For an Instagram channel, you must [connect to an Instagram professional account](t2746079.xdita#).'."\n" ."\n" .''."\n" ."\n" .'- For a Viber channel, you must [connect to an Instagram professional account](t2746079.xdita#).'."\n" ."\n" .''."\n" ."\n\n" .'### QPS limits'."\n" ."\n" .'- This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.'."\n" ."\n" .'- A single request supports a maximum of 1,000 numbers.'."\n" ."\n" .'### Status changes'."\n" ."\n" .'Message sending status can be monitored via Simple Message Service or HTTP callback. For details, see [Message receipts](~~421545~~).', 'changeSet' => [ ['createdAt' => '2026-03-10T03:28:30.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2026-02-27T07:44:56.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2026-02-27T07:44:55.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-09-15T02:20:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-07-30T07:56:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-04-21T11:36:42.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-26T05:51:55.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-14T03:24:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-21T09:48:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T14:40:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-07-04T11:30:33.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-04-13T11:48:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-11-17T11:45:53.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-30T07:05:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-08-18T12:13:12.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendChatappMassMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SendChatappMassMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'SendChatappMessage' => [ 'summary' => 'Sends a ChatApp message.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeCode' => '130289', 'abilityTreeNodes' => ['FEATUREcamsU2M7I2'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **whatsapp**'."\n" ."\n" .'- **messenger**'."\n" ."\n" .'- **instagram**'."\n" ."\n" .'- **telegram**'."\n" ."\n" .''."\n" ."\n" .'- **viber**'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'example' => 'whatsapp', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => ['description' => 'The message type. Valid values:'."\n" ."\n" .'- `template`: A message template approved in the console. You can send this type of message at any time.'."\n" ."\n" .'- `message`: A message of any format. You can send this type of message only within 24 hours of receiving the last message from a user.'."\n" ."\n" .'>'."\n" ."\n" .'If you set `Type` to `template`, you must set the `TemplateCode` parameter. If you set `Type` to `message`, you must set the `MessageType` parameter.'."\n" ."\n" .'>', 'type' => 'string', 'required' => true, 'example' => 'message', 'title' => ''], ], [ 'name' => 'MessageType', 'in' => 'query', 'schema' => ['description' => 'The message type to use when `Type` is set to `message`. The valid values vary based on the channel type:'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'WHATSAPP'."\n" ."\n" .'

'."\n" ."\n" .'- `text`: A text message.'."\n" ."\n" .'- `image`: An image message.'."\n" ."\n" .'- `video`: A video message.'."\n" ."\n" .'- `audio`: An audio message.'."\n" ."\n" .'- `document`: A document message.'."\n" ."\n" .'- `interactive`: An interactive message.'."\n" ."\n" .'- `location`: A location message.'."\n" ."\n" .'- `contacts`: A contacts message.'."\n" ."\n" .'- `reaction`: A reaction message.'."\n" ."\n" .'- `sticker`: A sticker message.'."\n" ."\n" .'- `typing_indicator`: A typing indicator message.'."\n" ."\n" .'- `pin`: A message to pin or unpin. This type is available only for group messages.'."\n" ."\n" .'- `carousel`: A carousel message.'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'VIBER'."\n" ."\n" .'

'."\n" ."\n" .'- `text`: A text message.'."\n" ."\n" .'- `image`: An image message.'."\n" ."\n" .'- `text_image_button`: A message with text, an image, and a button.'."\n" ."\n" .'- `text_button`: A message with text and a button.'."\n" ."\n" .'- `document`: A document message.'."\n" ."\n" .'- `video`: A video message.'."\n" ."\n" .'- `text_video`: A message with text and a video.'."\n" ."\n" .'- `text_video_button`: A message with text, a video, and a button.'."\n" ."\n" .'- `text_image`: A message with text and an image.'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'MESSENGER / INSTAGRAM'."\n" ."\n" .'

'."\n" ."\n" .'- `text`: A text message.'."\n" ."\n" .'- `image`: An image message.'."\n" ."\n" .'- `video`: A video message.'."\n" ."\n" .'- `document`: A document message.'."\n" ."\n" .'- `audio`: An audio message.'."\n" ."\n" .'- `interactive`: An interactive message.'."\n" ."\n" .'- `couponTemplate`: A coupon template message.'."\n" ."\n" .'- `regularTemplate`: A regular template message.'."\n" ."\n" .'- `quickReply`: A quick reply message.'."\n" ."\n" .'- `buttonTemplate`: A button template message.'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'

'."\n" ."\n" .'TELEGRAM'."\n" ."\n" .'

'."\n" ."\n" .'- `text`: A text message.'."\n" ."\n" .'- `image`: An image message.'."\n" ."\n" .'- `video`: A video message.'."\n" ."\n" .'- `audio`: An audio message.'."\n" ."\n" .'- `document`: A document message.'."\n" ."\n" .'- `location`: A location message.'."\n" ."\n" .'- `gif`: An animated GIF message.'."\n" ."\n" .'- `sticker`: A sticker message.'."\n" ."\n" .'

', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], ], [ 'name' => 'TemplateCode', 'in' => 'query', 'schema' => ['description' => 'The message template code. You can find the code on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Template Design** page.', 'type' => 'string', 'required' => false, 'example' => '1119***************'."\n", 'title' => ''], ], [ 'name' => 'Language', 'in' => 'query', 'schema' => ['description' => 'The language of the message template. For a list of supported languages and their corresponding codes, see [language code](~~463420~~).', 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ 'name' => 'From', 'in' => 'query', 'schema' => ['description' => 'The sender\'s number or ID.'."\n" ."\n" .'- If `ChannelType` is **whatsapp**, this is the phone number registered with WhatsApp. You can find the number on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **WABA Management** > **Phone Number Management** page.'."\n" ."\n" .'- If `ChannelType` is **messenger**, this is the Facebook Page ID. You can find this ID on your [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Facebook Page** page.'."\n" ."\n" .'- If `ChannelType` is **instagram**, this is the Instagram professional account ID (Account ID). You can find the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Professional Account** page.'."\n" ."\n" .''."\n" ."\n" .'- If `ChannelType` is **viber**, this is the Viber service ID (Service ID). You can find the ID on the [**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Service Number Management** page.'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'example' => '861387777****', 'title' => ''], ], [ 'name' => 'To', 'in' => 'query', 'schema' => ['description' => 'The recipient\'s number or ID.'."\n" ."\n" .'- If `ChannelType` is **whatsapp**, this is the recipient\'s phone number.'."\n" ."\n" .'- If `ChannelType` is **messenger**, this is a Page-Scoped User ID (PSID) generated when a user interacts with your Facebook Page.'."\n" ."\n" .'- If `ChannelType` is **instagram**, this is an Instagram-Scoped User ID (IGSID) generated when a user interacts with your Instagram business or creator account.'."\n" ."\n" .''."\n" ."\n" .'- If `ChannelType` is **viber**, this is the recipient\'s phone number.'."\n" ."\n" .'', 'type' => 'string', 'required' => true, 'example' => '861388988****', 'title' => ''], ], [ 'name' => 'TemplateParams', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The parameters for the message template.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'A key-value pair for a template parameter. The key is the parameter\'s name and the value is its corresponding value.', 'type' => 'string', 'example' => '{'."\n" .' "param1": "value1",'."\n" .' "param2": "value2"'."\n" .'}', 'title' => ''], 'example' => '', 'title' => '', ], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['description' => 'The message content, in a JSON-formatted string.'."\n" ."\n" .'**Notes for WhatsApp messages:**'."\n" ."\n" .'- If `MessageType` is `text`, the `text` field is required, and the `Caption` field is not supported.'."\n" ."\n" .'- If `MessageType` is `image`, the `Link` field is required.'."\n" ."\n" .'- If `MessageType` is `video`, the `Link` field is required.'."\n" ."\n" .'- If `MessageType` is `audio`, the `Link` field is required. The `Caption` field is not supported.'."\n" ."\n" .'- If `MessageType` is `document`, the `Link` and `FileName` fields are required. The `Caption` field is not supported.'."\n" ."\n" .'- If `MessageType` is `interactive`, the `type` and `action` fields are required.'."\n" ."\n" .'- If `MessageType` is `contacts`, the `name` field is required.'."\n" ."\n" .'- If `MessageType` is `location`, the `longitude` and `latitude` fields are required.'."\n" ."\n" .'- If `MessageType` is `sticker`, the `Link` field is required. The `Caption` and `FileName` fields are not supported.'."\n" ."\n" .'- If `MessageType` is `reaction`, the `messageId` and `emoji` fields are required.'."\n" ."\n" .'**Notes for Messenger messages:**'."\n" ."\n" .'- If `MessageType` is `text`, the `text` field is required.'."\n" ."\n" .'- If `MessageType` is `image`, `video`, `audio`, or `document`, the `link` field is required.'."\n" ."\n" .'**Notes for Instagram messages:**'."\n" ."\n" .'- If `MessageType` is `text`, the `text` field is required.'."\n" ."\n" .'- If `MessageType` is `image`, `video`, or `audio`, the `link` field is required.'."\n" ."\n" .''."\n" ."\n" .'**Notes for Viber messages:**'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `text`, the `text` field is required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `image`, the `link` field is required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `video`, the `link`, `thumbnail`, `fileSize`, and `duration` fields are required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `document`, the `link`, `fileName`, and `fileType` fields are required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `text_button`, the `text`, `caption`, and `action` fields are required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `text_image_button`, the `text`, `link`, `caption`, and `action` fields are required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `text_video`, the `text`, `link`, `thumbnail`, `fileSize`, and `duration` fields are required.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- If `MessageType` is `text_video_button`, the `text`, `link`, `thumbnail`, `fileSize`, `duration`, and `caption` fields are required. The `action` field is not supported.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => '{'."\n" .' "text": "hello,whatsapp",'."\n" .' "link": "https://*******",'."\n" .' "caption": "****",'."\n" .' "fileName": "****"'."\n" .'}', 'title' => ''], ], [ 'name' => 'Payload', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'An array of custom data strings that are sent to your webhook when a user clicks a corresponding button.', 'type' => 'array', 'items' => ['description' => 'The payload for a button in the message template.', 'type' => 'string', 'required' => false, 'example' => 'payloadtext'."\n", 'title' => ''], 'required' => false, 'example' => 'payloadtext1,payloadtext2,payloadtext3', 'title' => '', ], ], [ 'name' => 'CustWabaId', 'in' => 'query', 'schema' => ['description' => '**Deprecated.** Use `CustSpaceId` instead. The WABA ID of an ISV\'s customer. For a direct customer, this is the Instance ID. You can find the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'cams-8c8*********'."\n", 'title' => ''], ], [ 'name' => 'FallBackId', 'in' => 'query', 'schema' => ['description' => 'The ID of the fallback strategy. This parameter is available only on the International Site and can be ignored if you are using the China site. You can find the strategy ID on the [**Fallback Policy**](https://chatapp.console.alibabacloud.com/FallbackStrategy) page.', 'type' => 'string', 'required' => false, 'example' => 'S0****', 'title' => ''], ], [ 'name' => 'FallBackContent', 'in' => 'query', 'schema' => ['description' => 'The custom content of the fallback message. This parameter is available only on the International Site and can be ignored if you are using the China site.', 'type' => 'string', 'required' => false, 'example' => 'Fallback SMS', 'title' => ''], ], [ 'name' => 'IsvCode', 'in' => 'query', 'schema' => ['description' => '**Deprecated.** A verification code used to authorize an ISV\'s sub-account. You can ignore this parameter.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => '123123******', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV\'s sub-account. For a direct customer, this is the Instance ID. You can find the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-8c8*********'."\n", 'title' => ''], ], [ 'name' => 'ContextMessageId', 'in' => 'query', 'schema' => ['description' => 'The ID of the message to which you are replying.', 'type' => 'string', 'required' => false, 'example' => '61851ccb2f1365b16aee****'."\n", 'title' => ''], ], [ 'name' => 'TrackingData', 'in' => 'query', 'schema' => ['description' => 'Custom tracking data for a Viber message. This parameter is available only on the International Site and can be ignored if you are using the China site.', 'type' => 'string', 'required' => false, 'example' => 'Tracking Data', 'title' => ''], ], [ 'name' => 'Label', 'in' => 'query', 'schema' => ['description' => 'The Viber message type. This parameter is available only on the International Site and can be ignored if you are using the China site.'."\n" .'Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **promotion**: A promotional or marketing message.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- **transaction**: A notification message.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => 'promotion', 'title' => ''], ], [ 'name' => 'Ttl', 'in' => 'query', 'schema' => ['description' => 'The time-to-live (TTL) for a Viber message. This parameter is available only on the International Site and can be ignored if you are using the China site. Unit: seconds. The value must be between 30 and 1209600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ 'name' => 'Tag', 'in' => 'query', 'schema' => ['description' => 'A custom tag for the Viber message.', 'type' => 'string', 'required' => false, 'example' => 'tag', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', 'schema' => ['description' => 'A custom task ID.', 'type' => 'string', 'required' => false, 'example' => '10000****', 'title' => ''], ], [ 'name' => 'FallBackDuration', 'in' => 'query', 'schema' => ['description' => 'The duration after which a fallback is triggered. This parameter is available only on the International Site and can be ignored if you are using the China site. If a delivery receipt is not returned within the specified period, a fallback is triggered. If this parameter is omitted, a fallback is triggered only if the message fails to send or a failed delivery receipt is returned. Unit: seconds. The value must be between 60 and 43200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120', 'title' => ''], ], [ 'name' => 'ProductAction', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Product information that you have uploaded to Meta. This parameter applies to WhatsApp channels only.', 'type' => 'object', 'properties' => [ 'ThumbnailProductRetailerId' => ['description' => 'The product catalog ID. You can get this ID by calling the [ListProductCatalog](~~2539783~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'skkks99****', 'title' => ''], 'Sections' => [ 'title' => '', 'description' => 'A list of product categories. You can specify up to 10 categories and a total of 30 products.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'A product category.', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'The category name. You can find the name on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Catalog Management** > **Product Management** page, or obtain it by calling the [ListProduct](~~2557786~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'abcd', 'title' => ''], 'ProductItems' => [ 'title' => '', 'description' => 'A list of product information.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The product information.', 'type' => 'object', 'properties' => [ 'ProductRetailerId' => ['description' => 'The product ID. You can find the ID on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Catalog Management** > **Product Management** page, or obtain it by calling the [ListProduct](~~2557786~~) operation.', 'type' => 'string', 'required' => false, 'example' => 'ksi3****', 'title' => ''], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'FallBackRule', 'in' => 'query', 'schema' => ['description' => 'The fallback rule. This parameter is available only on the International Site and can be ignored if you are using the China site.'."\n" .'Valid values:'."\n" ."\n" .''."\n" ."\n" .'- **undelivered**: A fallback is triggered if message delivery fails. The template and parameters must be valid at the time of sending. Blocked templates or phone numbers are not validated. This is the default rule if the parameter is empty.'."\n" ."\n" .''."\n" ."\n" .''."\n" ."\n" .'- **sentFailed**: A fallback is triggered if the message fails parameter validation, such as for the template or template parameters. Only the existence of `channelType`, `type`, `messageType`, `to`, and `from` is strictly validated.'."\n" ."\n" .'', 'type' => 'string', 'required' => false, 'example' => 'undelivered', 'title' => ''], ], [ 'name' => 'FlowAction', 'in' => 'query', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The Flow message object.', 'type' => 'object', 'properties' => [ 'FlowActionData' => [ 'title' => '', 'description' => 'A collection of default flow parameters.', 'type' => 'object', 'required' => false, 'additionalProperties' => ['description' => 'A default flow parameter in key-value format. The key is the parameter name, and the value is the parameter value.', 'type' => 'any', 'example' => '{'."\n" .' "name": "name"'."\n" .'}', 'title' => ''], 'example' => '', ], 'FlowToken' => ['description' => 'The custom flow token.', 'type' => 'string', 'required' => false, 'example' => 'kde****', 'title' => ''], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'TemplateName', 'in' => 'query', 'schema' => ['description' => 'The template name. You can find the template name on the [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Template Design** page.', 'type' => 'string', 'required' => false, 'example' => 'test_name', 'title' => ''], ], [ 'name' => 'RecipientType', 'in' => 'query', 'schema' => ['description' => 'The recipient type. Valid values:'."\n" ."\n" .'- `individual`: A single recipient.'."\n" ."\n" .'- `group`: A group.', 'type' => 'string', 'required' => false, 'example' => 'individual', 'default' => 'individual', 'title' => ''], ], [ 'name' => 'MessageCampaignId', 'in' => 'query', 'schema' => ['description' => 'The ID of the message campaign.'."\n" ."\n" .'> This parameter is for internal testing, is not generally available, and can be ignored.', 'type' => 'string', 'required' => false, 'example' => '123123********'."\n", 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The Meta ad account ID.'."\n" ."\n" .'> This parameter is for internal testing, is not generally available, and can be ignored.', 'type' => 'string', 'required' => false, 'example' => '123123********', 'title' => ''], ], [ 'name' => 'TokenType', 'in' => 'query', 'schema' => ['description' => 'The token type.'."\n" ."\n" .'> This parameter is for internal testing, is not generally available, and can be ignored.', 'type' => 'string', 'required' => false, 'example' => 'bearer', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', 'schema' => ['description' => 'The message category for direct WhatsApp sending.'."\n" ."\n" .'>'."\n" ."\n" .'Specify this parameter only if you are a Meta-invited customer. Otherwise, the message may fail to send.'."\n" ."\n" .'>', 'type' => 'string', 'required' => false, 'example' => 'UTILITY', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866******', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'User not authorized to operate on the specified resource.', 'title' => ''], 'Code' => ['description' => 'The status code of the request.'."\n" ."\n" .'- A value of OK indicates a successful request.'."\n" ."\n" .'- For other status codes, see [error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'MessageId' => ['description' => 'The ID of the message.', 'type' => 'string', 'example' => '61851ccb2f1365b16aee****', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\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' => '- Call this operation to send messages. You can also send messages manually in the console at [**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)[**Channel Management**](https://chatapp.console.alibabacloud.com/CustomerList) > **Manage** > **Message Sending**.'."\n" ."\n" .'- Before calling this operation, you must create a channel and have an approved template.'."\n" ."\n" .'- For a WhatsApp channel, you must [register and bind a WABA](~~172335~~) and [add a phone number](~~2656131~~).'."\n" ."\n" .'- For a Messenger channel, you must [connect to a Facebook Page](~~2837713~~).'."\n" ."\n" .'- For an Instagram channel, you must [connect to an Instagram professional account](~~2837720~~).'."\n" ."\n" .''."\n" ."\n" .'- For a Viber channel, you must [apply for a service ID](~~2807995~~).'."\n" ."\n" .''."\n" ."\n\n" .'### QPS limit'."\n" ."\n" .'The QPS limit for this operation is 250 per user. API calls that exceed this limit are throttled. To prevent service disruptions, ensure your calls stay within this limit.'."\n" ."\n" .'### Status changes'."\n" ."\n" .'You can receive notifications about message status changes by using MNS or HTTP callbacks. For more information, see [message receipts](~~421545~~).', 'changeSet' => [ ['createdAt' => '2026-03-10T03:28:53.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2026-02-27T07:45:02.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2026-02-27T07:44:55.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-09-15T02:20:12.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-07-30T07:56:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-06-24T09:46:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-04-21T11:36:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-26T05:51:55.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-04-10T09:38:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-03-14T03:24:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-11-21T13:08:30.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-09-21T09:48:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-08-01T14:40:53.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2023-04-13T11:48:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-03-02T12:02:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2022-12-27T06:21:38.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-12-21T02:06:41.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-11-17T10:02:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-09-20T06:31:03.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-07-15T09:53:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2022-03-24T03:16:03.000Z', 'description' => 'OpenAPI offline'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendChatappMessage'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SendChatappMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'SubmitIsvCustomerTerms' => [ 'summary' => 'Submits the agreement information for independent software vendor (ISV) customers.', 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'abilityTreeCode' => '170261', 'abilityTreeNodes' => ['FEATUREcams2DCA0B'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the user within the independent software vendor (ISV) account.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'CustName', 'in' => 'query', 'schema' => ['description' => 'The enterprise name.', 'type' => 'string', 'required' => true, 'example' => 'Aliyun', 'title' => ''], ], [ 'name' => 'OfficeAddress', 'in' => 'query', 'schema' => ['description' => 'The enterprise address.', 'type' => 'string', 'example' => 'Hangzhou', 'required' => true, 'title' => ''], ], [ 'name' => 'ContactMail', 'in' => 'query', 'schema' => ['description' => 'The enterprise mail.', 'type' => 'string', 'required' => true, 'example' => 'partner@aliyun.com', 'title' => ''], ], [ 'name' => 'CountryId', 'in' => 'query', 'schema' => ['description' => 'The country code.'."\n" ."\n" .'> For more information about country codes, see [Country codes](~~608210~~).', 'type' => 'string', 'required' => true, 'example' => 'CN', 'title' => ''], ], [ 'name' => 'BusinessDesc', 'in' => 'query', 'schema' => ['description' => 'The business scenario.', 'type' => 'string', 'example' => 'Marketing products', 'required' => true, 'title' => ''], ], [ 'name' => 'IsvTerms', 'in' => 'query', 'schema' => ['description' => 'The ISV or Client agreement.', 'type' => 'string', 'required' => true, 'example' => 'isvTerms.pdf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The HTTP status code returned.'."\n" ."\n" .'- A value of OK indicates that the call is successful.'."\n" ."\n" .'- Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '/', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => '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-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"AccessDeniedDetail\\": \\"/\\"\\n}","type":"json"}]', 'title' => 'SubmitIsvCustomerTerms', 'description' => '- This operation allows a maximum of 5 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.'."\n" ."\n" .'- After you call the [GetChatappUploadAuthorization](~~GetChatappUploadAuthorization~~) operation to obtain the authentication information for uploading the file to Object Storage Service (OSS), you can use the authentication information to upload the file to the OSS server. To upload the file, you can call the SDK provided by OSS. When you upload the file, set the value of the key to the value of `Dir + "/" + file name`, such as C200293990209/isvTerms.pdf. The value of Dir is obtained from the [GetChatappUploadAuthorization](~~GetChatappUploadAuthorization~~) operation. The value of IsvTerms is obtained from the PutObject operation.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:07.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:30:34.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIsvCustomerTerms'], ], ], 'ramActions' => [], 'translator' => 'manual', ], 'SubmitVerifyCodeResult' => [ 'summary' => 'Submits the result of a verification code check.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREcamsSI56U4'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ 'name' => 'MessageId', 'in' => 'query', 'schema' => ['description' => 'The message ID.', 'type' => 'string', 'required' => true, 'example' => '202605012020***', 'title' => ''], ], [ 'name' => 'To', 'in' => 'query', 'schema' => ['description' => 'The recipient number.', 'type' => 'string', 'required' => false, 'example' => '86138000***', 'title' => ''], ], [ 'name' => 'Result', 'in' => 'query', 'schema' => ['description' => 'The verification result.', 'type' => 'boolean', 'required' => true, 'example' => 'TRUE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of `OK` indicates that the request was successful.'."\n" ."\n" .'- See the [error code list](~~196974~~) for other error codes.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- true: The request was successful.'."\n" ."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SubmitVerifyCodeResult', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SubmitVerifyCodeResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Data\\": \\"example\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'SyncBusinessAppHistory' => [ 'methods' => ['post', 'get'], 'schemes' => ['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' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-x***', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number of the business.', 'type' => 'string', 'required' => true, 'example' => '8613800**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Code' => ['description' => 'The request status code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Sync business app historical messages', 'summary' => 'Synchronizes business app historical records.', 'description' => '- Before calling this operation, configure the webhooks for messages and receipts by using [UpdatePhoneWebhook](~~600763~~) and [UpdateAccountWebhook](~~600765~~). Otherwise, the webhook address cannot be found during historical message synchronization, which causes the synchronization to fail.'."\n" ."\n" .'- This operation takes effect only once. After the first call, subsequent calls do not trigger historical message pushes.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Code\\": \\"example\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SyncFlow' => [ 'summary' => '', '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' => ['description' => '通道实例', 'type' => 'string', 'required' => true, 'example' => 'cams-kei****', 'default' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '{}', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '172D586A-5E9D-11C8-BED3-7E4A0***', 'description' => '', 'title' => ''], 'Code' => ['type' => 'integer', 'format' => 'int64', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"172D586A-5E9D-11C8-BED3-7E4A0***\\",\\n \\"Code\\": 0,\\n \\"Success\\": false\\n}","type":"json"}]', ], 'SyncMessageCampaign' => [ 'summary' => 'Synchronously queries the budget.', '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' => 'The ID of the Messenger page.', 'type' => 'string', 'required' => true, 'example' => '238**', 'title' => ''], ], [ 'name' => 'AdAccountId', 'in' => 'query', 'schema' => ['description' => 'The ID of the Meta ad account.', 'type' => 'string', 'required' => true, 'example' => '244**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '233**', 'title' => ''], 'Code' => ['description' => 'The status code of the request. A value of OK indicates that the request was successful.'."\n" ."\n" .'For other error codes, see Error Codes.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SyncMessageCampaign', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:SyncMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"233**\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SyncMessengerSubscriptionToken' => [ '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' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => true, 'example' => 'cams-xi****', 'title' => ''], ], [ 'name' => 'PageId', 'in' => 'query', 'schema' => ['description' => 'The PageId of Messenger.', 'type' => 'string', 'required' => true, 'example' => '2030***', 'title' => ''], ], [ 'name' => 'CustomAudienceId', 'in' => 'query', 'schema' => ['description' => 'The custom audience ID.', 'type' => 'string', 'required' => false, 'example' => '20399***', 'title' => ''], ], [ 'name' => 'TokenType', 'in' => 'query', 'schema' => ['description' => 'The token type.', 'type' => 'string', 'required' => true, 'example' => 'customAudience', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'TaskCode' => ['description' => 'The task code.', 'type' => 'string', 'example' => '39ss**', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '39***', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Sync custom audience token', 'summary' => 'Queries the Messenger subscription token.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:SyncMessengerSubscriptionToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"TaskCode\\": \\"39ss**\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"39***\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'TriggerChatFlow' => [ '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' => 'The code of the flow. View the flow code on the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) page.', 'type' => 'string', 'required' => true, 'example' => '9ccc41**************************'."\n", 'title' => ''], ], [ 'name' => 'Data', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The input parameters in a key-value format. The keys must match the input parameter policy configured in the start node of the flow. To view the variable names in the start node, go to the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder), click the name of the flow, and open the orchestration canvas.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" .' "my_biz_data_0": "hi",'."\n" .' "my_biz_data_1": "1024"'."\n" .'}', 'title' => ''], ], [ 'name' => 'Uuid', 'in' => 'query', 'schema' => ['description' => 'A custom unique ID for the event, used to ensure idempotence. Do not include business semantics in the ID. After the flow is triggered, you can retrieve this parameter from within the flow.', 'type' => 'string', 'required' => false, 'example' => 'c68622e6-5f0d-c8a4-af41-e949c2a7580e'."\n", 'title' => ''], ], [ 'name' => 'OutId', 'in' => 'query', 'schema' => ['description' => 'A custom serial number from an external system. Use this parameter to associate the trigger with an external business process. After the flow is triggered, you can retrieve this parameter from within the flow.', 'type' => 'string', 'required' => false, 'example' => '8d4acf7e-e360-eb83-6d74-fcf9c4538fda'."\n", 'title' => ''], ], [ 'name' => 'ClaimTimeMillis', 'in' => 'query', 'schema' => ['description' => 'The time when the event occurs. This is when the flow is triggered and is typically the time when the request is created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731502129000', 'title' => ''], ], [ 'name' => 'DiscardTimeMillis', 'in' => 'query', 'schema' => ['description' => 'The time when the event expires. If you specify this parameter, the trigger is canceled if the request is not processed before this time. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1731502729000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denied error.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Trigger an Online Flow', 'summary' => 'Triggers an online chat flow that has a manual trigger.', 'description' => '- You can call this operation to trigger a published version of a flow that has a manual trigger. You can also trigger the flow from the [Marketing Campaign Management](https://chatapp.console.aliyun.com/MarketingActivityManagement) page if the flow is associated with a marketing campaign.'."\n" ."\n" .'- Before you call this operation, make sure that the flow has a manual trigger and is published.'."\n" ."\n" .'- If a flow with a manual trigger does not have a published version, you must publish it. In [Chat Flow](https://chatapp.console.aliyun.com/ChatFlowBuilder), you can click the flow name to open the canvas and publish the version. Alternatively, you can call the [OnlineFlowVersion](~~2937203~~) API to publish the version.'."\n" ."\n" .'- If your flow contains components that incur costs, such as message sending or function invocations, make sure that you understand the billing methods and pricing for these products before you trigger the flow.', 'requestParamsDescription' => 'None.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerChatFlow'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:TriggerChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], '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' => ['type' => 'string', 'required' => true, 'example' => 'cams-*', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => 'None', 'title' => ''], 'Message' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => 'xx-xx***', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => 'NONE', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => 'OK', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:UnbindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdateAccountWebhook' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162636', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '2934839388494****', 'title' => ''], ], [ 'name' => 'StatusCallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL to which status reports are sent by using HTTP callbacks.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], ], [ 'name' => 'HttpFlag', 'in' => 'query', 'schema' => ['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" .'- N: indicates that HTTP callbacks are not used to receive receipts.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'QueueFlag', 'in' => 'query', 'schema' => ['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" .'- N: indicates that MNS queues are not used to receive receipts.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '744c4b5c79c9432497a075bdfca3****', 'title' => ''], 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], 'Code' => ['description' => 'The HTTP status code returned.'."\n" ."\n" .'- A value of OK indicates that the call is successful.'."\n" ."\n" .'- Other values indicate that the call fails. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], [], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'eventInfo' => [ 'enable' => false, 'eventNames' => [], ], 'title' => 'UpdateAccountWebhook', 'summary' => 'Modifies the callback URL of an account.', 'description' => 'This operation allows a maximum of 10 requests per second per account. Excess requests are throttled, which may affect your business. Stay within the specified limit.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-11-06T12:50:07.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2023-07-04T11:30:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccountWebhook'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateAccountWebhook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"744c4b5c79c9432497a075bdfca3****\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'UpdateAuditRequest' => [ 'summary' => 'Modifies a Viber application.', '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' => 'The request number.', 'type' => 'string', 'required' => true, 'example' => '114624518**5956096', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer or the instance ID. View it on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-8pi**urn5s', 'title' => ''], ], [ 'name' => 'AuditResult', 'in' => 'query', 'schema' => ['description' => 'The audit result.', 'type' => 'string', 'required' => false, 'example' => 'unAudit', 'title' => ''], ], [ 'name' => 'AuditRecord', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'ContactMail' => ['description' => 'Contact mailbox.', 'type' => 'string', 'required' => false, 'example' => 'xxxx@gamil.com', 'title' => ''], 'CompanyLegalName' => ['description' => 'Company legal name.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'LetterGuarantee' => ['description' => 'Letter of guarantee (download address).', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.xxx.xxx', 'title' => ''], 'IndustryInvolved' => ['description' => 'Industry involved.', 'type' => 'string', 'required' => false, 'example' => 'telecommunicationsAndIT', 'title' => ''], 'MessageDestinationInternationalCountry' => [ 'type' => 'array', 'items' => ['description' => 'List of international destination countries and regions.', 'type' => 'string', 'required' => false, 'example' => '["1|AI","374|AM"]', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'International destination countries and regions.', 'title' => '', ], 'CompleteAddressOfHeadquarters' => ['description' => 'Complete address of headquarters.', 'type' => 'string', 'required' => false, 'example' => 'xxxstreet', 'title' => ''], 'MessageEnableDate' => ['description' => 'Commercial message enable date (GMT).', 'type' => 'string', 'required' => false, 'example' => '2025-11-07', 'title' => ''], 'BusinessLicenseRegistrationNumber' => ['description' => 'Business license registration number.', 'type' => 'string', 'required' => false, 'example' => '9211515**345', 'title' => ''], 'CompanyLegalPerson' => ['description' => 'Company legal person name.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'CompanyAddress' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyAddress' => ['description' => 'Company address.', 'type' => 'string', 'required' => false, 'example' => '123 Sunshine Street, City, Country', 'title' => ''], 'CompanyAddressTitle' => ['description' => 'Company address title.', 'type' => 'string', 'required' => false, 'example' => 'xxx company', 'title' => ''], ], 'required' => false, 'description' => 'Company address details.', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'description' => 'Company addresses.', 'title' => '', ], 'CompanyRegisteredCountry' => ['description' => 'Company registered country or region.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], 'AgeLimit' => [ 'description' => 'Age limit.', 'enumValueTitles' => ['unlimited' => '', 'eighteenUp' => '', 'twentyOneUp' => ''], 'type' => 'string', 'required' => false, 'example' => 'unlimited', 'title' => '', ], 'IndustryDescription' => ['description' => 'Industry description.', 'type' => 'string', 'required' => false, 'example' => 'description', 'title' => ''], 'WebAddress' => ['description' => 'Company website.', 'type' => 'string', 'required' => false, 'example' => 'https://www.xxx.xxx.com', 'title' => ''], 'EnableAutoReply' => ['description' => 'Enable auto-reply (this field is deprecated).', 'type' => 'string', 'required' => false, 'example' => 'N/A‌', 'title' => ''], 'RecoveryDate' => ['description' => 'Recovery date.', 'type' => 'string', 'required' => false, 'example' => '2025-11-07', 'title' => ''], 'BusinessAccountName' => ['description' => 'Business account name.', 'type' => 'string', 'required' => false, 'example' => 'testaccount', 'title' => ''], 'ApplyReason' => ['description' => 'Application reason.', 'type' => 'string', 'required' => false, 'example' => 'reason', 'title' => ''], 'Logo' => [ 'type' => 'array', 'items' => ['description' => 'Logo collection (download addresses).', 'type' => 'string', 'required' => false, 'example' => '[xxx,xxx,xxx]', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'Logo', 'title' => '', ], 'ReplyContent' => ['description' => 'Reply content (deprecated).', 'type' => 'string', 'required' => false, 'example' => 'N/A', 'title' => ''], 'CompanyProfile' => ['description' => 'Company profile.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'CompanyTel' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CompanyTelNumber' => ['description' => 'Company phone number.', 'type' => 'string', 'required' => false, 'example' => '07364245xxxx', 'title' => ''], 'CompanyTelTitle' => ['description' => 'Phone number title.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], 'required' => false, 'description' => 'Company phone number details.', 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'description' => 'Company phone numbers.', 'title' => '', ], 'MessageDialogueIntroduction' => ['description' => 'Commercial message dialogue introduction.', 'type' => 'string', 'required' => false, 'example' => 'hello!', 'title' => ''], 'OtherLetterGuarantee' => ['description' => 'Supplementary material address.', 'type' => 'string', 'required' => false, 'example' => 'https://xxx.xxx.com', 'title' => ''], 'MessageDestinationCountry' => [ 'type' => 'array', 'items' => ['description' => 'Collection of local destination countries or regions.', 'type' => 'string', 'required' => false, 'example' => '["1|AI","374|AM"]', 'title' => ''], 'required' => false, 'example' => '', 'description' => 'Local destination countries or regions.', 'title' => '', ], 'MessageSessionName' => ['description' => 'Commercial message dialogue name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], 'SuspensionDate' => ['description' => 'Deprecated.', 'type' => 'string', 'required' => false, 'example' => 'N/A', 'title' => ''], 'CompanyEnglishName' => ['description' => 'Company English name.', 'type' => 'string', 'required' => false, 'example' => 'baidu', 'title' => ''], 'ContactPhone' => ['description' => 'Contact phone number.', 'type' => 'string', 'required' => false, 'example' => '861515115***', 'title' => ''], 'ContactPosition' => ['description' => 'Contact position.', 'type' => 'string', 'required' => false, 'example' => 'job', 'title' => ''], 'ContactEmail' => ['description' => 'Contact mailbox.', 'type' => 'string', 'required' => false, 'example' => '5**8585@gmail.com', 'title' => ''], 'ContactName' => ['description' => 'Contact name.', 'type' => 'string', 'required' => false, 'example' => 'mary', 'title' => ''], ], 'required' => true, 'description' => 'Viber audit items.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Access denied details.', 'type' => 'string', 'example' => '{}', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The ID of this API call request. Alibaba Cloud generates this unique identifier for the request. Use it to troubleshoot and locate issues.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Data' => ['description' => 'Returns the RequestNo.', 'type' => 'object', 'example' => '14111561****', 'title' => ''], 'Code' => ['description' => 'Request status code.'."\n" ."\n" .'- OK indicates a successful request.'."\n" ."\n" .'- For other error codes, see [Error Codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateAuditRequest', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateAuditRequest', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdateChatFlow' => [ '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' => 'The updated name of the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '测试流程'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The updated remarks for the flow.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '流程备注'], ], [ 'name' => 'FlowCode', 'in' => 'query', 'schema' => ['description' => 'The flow code. You can view the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'."\n"], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The business tenant code. The default value is ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The business extension information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Update Process', 'summary' => 'Updates the basic information of a flow based on the flow code.', 'description' => '- You can call this operation to update the basic information of a flow, or update it manually on the **Basic Information** page under **Settings** in the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder).'."\n" ."\n" .'- Before calling this operation, make sure that you have created a flow.'."\n" ."\n" .'- If you have not created a flow, go to the [**Flow Editor**](https://chatapp.console.aliyun.com/ChatFlowBuilder) and click **Create Flow** to create one.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'UpdateChatFlowLogSetting' => [ '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' => 'The flow code. You can view the flow code in the [Flow Builder](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'example' => '9ccc41**************************', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', 'schema' => ['description' => 'The unique ID of the setting. You can obtain this ID by calling the [ReadChatFlowLogSetting](~~2937212~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], ], [ 'name' => 'Status', 'in' => 'query', 'schema' => [ 'description' => 'The log enabling status. Valid values:'."\n" .'- ENABLED: Enables log writing.'."\n" ."\n" .'- DISABLED: Disables log writing but retains the Simple Log Service log instance.'."\n" ."\n" .'- DELETED: Disables log writing and deletes the Simple Log Service log instance.', 'enumValueTitles' => [], 'type' => 'string', 'required' => false, 'example' => 'ENABLED', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Data' => ['description' => 'The returned data object.', 'type' => 'object', 'example' => '', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update flow log settings', 'summary' => 'Updates the flow log settings.', 'description' => '- You can call this operation to update flow log settings, or manually update them in [**Flow Builder**](https://chatapp.console.aliyun.com/ChatFlowBuilder) > **Settings** > **Log**.'."\n" ."\n" .'- Before calling this operation, make sure that you have activated [Simple Log Service](https://sls.console.aliyun.com/lognext/open) and created flow log settings.'."\n" ."\n" .'- If you have not created flow log settings for the flow, first create them by calling the [CreateChatFlowLogSetting](~~2937211~~) operation.'."\n" ."\n" .'- Updating flow log settings may affect your business. Proceed with caution.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:UpdateChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdateChatGroup' => [ 'summary' => 'Modifies the information of an IM group.', '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' => 'The business phone number. You can view the business phone number by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => '8613800***', 'title' => ''], ], [ 'name' => 'ChannelType', 'in' => 'query', 'schema' => ['description' => 'The channel type. Valid values:'."\n" ."\n" .'- **WHATSAPP**.'."\n" ."\n" .'> Only the WhatsApp channel type is supported.', 'type' => 'string', 'required' => false, 'example' => 'WHATSAPP', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer, which is also the instance ID. This is the channel ID, which can be viewed on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-***', 'title' => ''], ], [ 'name' => 'GroupId', 'in' => 'query', 'schema' => ['description' => 'The group ID. You can view the group ID by calling the [ListChatGroup](~~2932629~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'EA303***', 'title' => ''], ], [ 'name' => 'Description', 'in' => 'query', 'schema' => ['description' => 'The group description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'Subject', 'in' => 'query', 'schema' => ['description' => 'The group subject.', 'type' => 'string', 'required' => false, 'example' => 'test title', 'title' => ''], ], [ 'name' => 'ProfilePictureFile', 'in' => 'query', 'schema' => ['description' => 'The group profile picture.'."\n" ."\n" .'> Image restrictions:'."\n" .'> - Supported MIME type: image/jpeg'."\n" .'> - Maximum image size: 5 MB'."\n" .'> - The image must be square with a minimum dimension of 192 × 192 pixels.', 'type' => 'string', 'required' => false, 'example' => 'https://*********/img.jpg'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'Code' => ['description' => 'The response code. Valid values:'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Result' => ['description' => 'The number of affected rows.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false,\\n \\"Result\\": 1\\n}","type":"json"}]', 'title' => 'Modify IM group information', 'description' => '>Modifying IM group information through API is a Meta beta feature. Contact your account manager to request allowlisting.>'."\n" .'- Creating WhatsApp groups through API is a Meta beta feature. Contact your account manager to request allowlisting.'."\n" ."\n" .'- Before calling this operation, make sure that you have an IM group that has been created.'."\n" ."\n" .'- If you do not have a created IM group, create one by calling the [AddChatGroup](~~2998429~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateCommerceSetting' => [ '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 Independent Software Vendor (ISV) sub-customer.', 'type' => 'string', 'required' => true, 'example' => '29348393884****', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '1380000****', 'title' => ''], ], [ 'name' => 'CartEnable', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the shopping cart. Valid values:'."\n" ."\n" .'- true: Enable the shopping cart.'."\n" ."\n" .'- false: Disable the shopping cart.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], ], [ 'name' => 'CatalogVisible', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable the product catalog. Valid values:'."\n" ."\n" .'- true: Enable the product catalog.'."\n" ."\n" .'- false: Disable the product catalog.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The returned object.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The response message. This parameter is returned when an error occurs.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- A value of OK indicates that the request is successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- **true**: successful.'."\n" ."\n" .'- **false**: failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateCommerceSetting', 'summary' => 'Updates the commerce settings for a phone number.', 'description' => 'This API is limited to 10 queries per second (QPS) for each user. If you exceed this limit, API calls are throttled, which can affect your business. Call this API within the specified limit.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCommerceSetting'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateCommerceSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdateContactById' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'ContactName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'ContactDetails', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'Country', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '无', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateContactById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Data\\": \\"示例值\\",\\n \\"Code\\": \\"示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'UpdateConversationalAutomation' => [ '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 welcome message.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The business phone number.', 'type' => 'string', 'required' => true, 'example' => '86130000***', 'title' => ''], ], [ 'name' => 'Commands', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of commands.', 'type' => 'array', 'items' => [ 'description' => 'The command object.', 'type' => 'object', 'properties' => [ 'CommandDescription' => ['description' => 'The command description.', 'type' => 'string', 'required' => false, 'example' => 'Command 1', 'title' => ''], 'CommandName' => ['description' => 'The command name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', 'title' => '', ], ], [ 'name' => 'Prompts', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The list of conversation starters.', 'type' => 'array', 'items' => ['description' => 'The conversation starter information.', 'type' => 'string', 'required' => false, 'example' => 'prompt1', 'title' => ''], 'required' => false, 'example' => '', 'title' => '', ], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer.', 'type' => 'string', 'required' => true, 'example' => '2993****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => '无', 'title' => ''], 'Message' => ['description' => 'The prompt message. This parameter is returned when an exception occurs.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O', 'title' => ''], 'Code' => ['description' => 'The response code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" .'- **true**: The call was successful.'."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify welcome message, conversation starters, and commands for a phone number', 'summary' => 'Modifies the welcome message, conversation starters, and commands for a phone number.', 'description' => '### QPS limit '."\n" .'The single-user QPS limit for this API is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this API appropriately.'."\n" ."\n" .'This API directly retrieves data from Facebook. Facebook imposes a limit on the total number of API calls. Use this API appropriately.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConversationalAutomation'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateConversationalAutomation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdateFlowJSONAsset' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '200972', 'abilityTreeNodes' => ['FEATUREcamsDKDS4Q'], ], 'parameters' => [ [ 'name' => 'FlowId', 'in' => 'query', 'schema' => ['description' => 'The flow ID.', 'type' => 'string', 'required' => true, 'example' => '2322334234234', 'title' => ''], ], [ 'name' => 'FilePath', 'in' => 'query', 'schema' => ['description' => 'The file path.', 'type' => 'string', 'required' => true, 'example' => 'http://www.xxxx.com/files/document.json', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer.', 'type' => 'string', 'required' => false, 'example' => 'cams-sdk2j3dnxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FlowId' => ['description' => 'Flow ID。', 'type' => 'string', 'example' => '92675332812643****', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The response code. OK indicates success.', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'Product.Unsubscript', 'errorMessage' => 'You have not subscribed to the specified product.', 'description' => 'You have not subscribed to the specified product.'], ['errorCode' => 'Ram.PermissionDeny', 'errorMessage' => 'You are not authorized to perform the operation.', 'description' => ''], ['errorCode' => 'System.LimitControl', 'errorMessage' => 'The system is under flow control.', 'description' => 'The system is under flow control.'], ['errorCode' => 'Unknown.ResourceOwnerId', 'errorMessage' => 'The resource does not belong to the current user.', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Update flow content by using JSON', 'summary' => 'Updates the content of a flow by using JSON.', 'description' => 'The China Mobile (China) QPS limit for this API is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Manage your calls appropriately.', 'changeSet' => [ ['createdAt' => '2026-01-14T01:42:27.000Z', 'description' => 'OpenAPI offline'], ['createdAt' => '2025-07-14T05:50:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:53.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowJSONAsset'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateFlowJSONAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdateFlowVersion' => [ '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' => 'The code of the flow. View the flow code in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder).', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '9ccc41**************************'], ], [ 'name' => 'FlowVersion', 'in' => 'query', 'schema' => ['description' => 'The version of the flow. In the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder), click the flow name to open the canvas and view the flow version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '1'], ], [ 'name' => 'FlowViewModel', 'in' => 'query', 'schema' => ['description' => 'The DSL data of the flow version, in JSON format. To obtain this data, orchestrate the components on the canvas in the Flow Editor. After you save the flow, click **Settings** > **Export** in the upper-right corner of the canvas to export the flow as a JSON data file.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '{'."\n" .' "schema": {'."\n" .' "namespace": "External",'."\n" .' "version": "1.0",'."\n" .' "copyright": "Alibaba Cloud"'."\n" .' },'."\n" .' "editor": "H4sIAAAAAAAAA+1YbU/c***********************",'."\n" .' "flow": {'."\n" .' "triggerType": "TriggeredByWhatsApp"'."\n" .' }'."\n" .'}'], ], [ 'name' => 'Remark', 'in' => 'query', 'schema' => ['description' => 'The remarks for the version.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '修复发送WhatsApp消息错误'], ], [ 'name' => 'BizCode', 'in' => 'query', 'schema' => [ 'description' => 'The tenant code. Default value: ALICOM\\_OPAAS.', 'type' => 'string', 'required' => false, 'enumValueTitles' => ['ALICOM_OPAAS' => 'ALICOM_OPAAS'], 'default' => 'ALICOM_OPAAS', 'title' => '', 'example' => 'ALICOM_OPAAS', ], ], [ 'name' => 'BizExtend', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The extended business information. The default value is an empty collection.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => '{}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Response' => ['description' => 'The content of the returned data.', 'type' => 'object', 'title' => '', 'example' => '436489'], 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'None'], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'title' => '', 'example' => 'OK'], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: The operation was successful.'."\n" ."\n" .'- false: The operation failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => 'Update Flow Version for Canvas Flow DSL Update', 'summary' => 'Updates the Domain-Specific Language (DSL) data of a flow version on the canvas.', 'description' => '- You can call this operation to update the DSL data of a flow version. You can also update the DSL data on the orchestration canvas in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder). To access the canvas, click the name of the flow.'."\n" ."\n" .'- Before calling this operation, make sure that you have created a flow and its status is Unpublished.'."\n" ."\n" .'- If you have not created a flow, you can manually create one in the [Flow Editor](https://chatapp.console.aliyun.com/ChatFlowBuilder) or call the [CreateChatFlow](~~2937204~~) operation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'UpdateGroupName' => [ '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' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值示例值', 'description' => '', 'title' => ''], ], [ 'name' => 'GroupName', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'example' => '示例值示例值', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['type' => 'string', 'description' => '', 'example' => '无', 'title' => ''], 'Message' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'RequestId' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Data' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Code' => ['type' => 'string', 'example' => '示例值示例值', 'description' => '', 'title' => ''], 'Success' => ['type' => 'boolean', 'example' => 'false', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'title' => '', 'summary' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateGroupName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Data\\": \\"示例值示例值\\",\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'staticInfo' => ['returnType' => 'synchronous'], ], 'UpdateInstance' => [ 'summary' => 'Updates the specified instance.', 'methods' => ['post', 'get'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '205981', 'abilityTreeNodes' => ['FEATUREcamsB6GVVZ'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', 'schema' => ['description' => 'The ID of the instance.', 'type' => 'string', 'required' => true, 'example' => '82838838****', 'default' => '', 'title' => ''], ], [ 'name' => 'InstanceName', 'in' => 'query', 'schema' => ['description' => 'The name of the instance.', 'type' => 'string', 'required' => true, 'example' => 'viber_ins', 'title' => ''], ], [ 'name' => 'InstanceDescription', 'in' => 'query', 'schema' => ['description' => 'The description of the instance.', 'type' => 'string', 'required' => false, 'example' => 'ins', 'title' => ''], ], [ 'name' => 'OfficeAddress', 'in' => 'query', 'schema' => ['description' => 'The company address.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], ], [ 'name' => 'ContactMail', 'in' => 'query', 'schema' => ['description' => 'The contact email address.', 'type' => 'string', 'required' => false, 'example' => '123@alibaba.com', 'title' => ''], ], [ 'name' => 'CountryId', 'in' => 'query', 'schema' => ['description' => 'The country code.'."\n" ."\n" .'> For a list of country codes, see [Country Codes](~~608210~~).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'FacebookBmId', 'in' => 'query', 'schema' => ['description' => 'The Facebook Business Manager ID.', 'type' => 'string', 'required' => false, 'example' => '393998****', 'title' => ''], ], [ 'name' => 'IsvTerms', 'in' => 'query', 'schema' => ['description' => 'The URL of the Independent Software Vendor (ISV) agreement file.', 'type' => 'string', 'required' => false, 'example' => 'https://aa.com/a.pdf', 'title' => ''], ], [ 'name' => 'IsConfirmAudit', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to enable automatic audit confirmation.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'Message' => ['description' => 'The response message. If the request fails, this field contains error details.', 'type' => 'string', 'example' => 'NULL', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'InstanceName' => ['description' => 'The name of the instance.', 'type' => 'string', 'example' => 'ins', 'title' => ''], 'ResourceRegionId' => ['description' => 'The ID of the region where the instance is located.', 'type' => 'string', 'example' => 'example', 'title' => ''], 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '293992992', 'title' => ''], 'InstanceDescription' => ['description' => 'The instance description.', 'type' => 'string', 'example' => 'des', 'title' => ''], 'ChannelType' => ['description' => 'The channel type.', 'type' => 'string', 'example' => 'VIBER', 'title' => ''], 'SubmitTime' => ['description' => 'The time when the instance information was submitted.', 'type' => 'string', 'example' => '2020-12-01 00:00:00', 'title' => ''], 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'des', 'title' => ''], ], 'example' => '', 'description' => 'The returned data object.', 'title' => '', ], 'Code' => ['description' => 'The status code of the response.'."\n" ."\n" .'- `OK` indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" ."\n" .'- **true**: The request was successful.'."\n" ."\n" .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdateInstance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Message\\": \\"NULL\\",\\n \\"Data\\": {\\n \\"InstanceName\\": \\"ins\\",\\n \\"ResourceRegionId\\": \\"example\\",\\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"}]', ], 'UpdateMarketingFLow' => [ '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' => 'The code of the campaign to modify.', 'type' => 'string', 'required' => false, 'example' => '115311507XXXX49888', 'title' => ''], ], [ 'name' => 'ActivityId', 'in' => 'query', 'schema' => ['description' => 'The ID of the campaign to modify.', 'type' => 'string', 'required' => false, 'example' => '674574575658675XX', 'title' => ''], ], [ 'name' => 'ActivityName', 'in' => 'query', 'schema' => ['description' => 'The campaign name.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'StartDate', 'in' => 'query', 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => false, 'example' => '2025-11-25 09:59:00', 'title' => ''], ], [ 'name' => 'ActivityDesc', 'in' => 'query', 'schema' => ['description' => 'The campaign description.', 'type' => 'string', 'required' => false, 'example' => '活动描述', 'title' => ''], ], [ 'name' => 'EndDate', 'in' => 'query', 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => false, 'example' => '2025-11-26 09:59:00', 'title' => ''], ], [ 'name' => 'ExecutionType', 'in' => 'query', 'schema' => ['description' => 'The execution method. Set this parameter to 1 (cron).', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'CronExpression', 'in' => 'query', 'schema' => ['description' => 'The cron expression for timed scheduling.', 'type' => 'string', 'required' => false, 'example' => '0 59 9 */1 * ?', 'title' => ''], ], [ 'name' => 'RelatedGroupId', 'in' => 'query', 'schema' => ['description' => 'The ID of the associated group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '114345654645XX', 'title' => ''], ], [ 'name' => 'RelatedFlowCode', 'in' => 'query', 'schema' => ['description' => 'The code of the associated flow.', 'type' => 'string', 'required' => false, 'example' => 'cf-kr3k31**mfeir8w', 'title' => ''], ], [ 'name' => 'RelatedFlowName', 'in' => 'query', 'schema' => ['description' => 'The name of the associated flow.', 'type' => 'string', 'required' => false, 'example' => 'testflow', 'title' => ''], ], [ 'name' => 'ParamFlag', 'in' => 'query', 'schema' => [ 'description' => 'Specifies whether to use custom pass-through parameters.', 'enumValueTitles' => ['Y' => 'Y', 'N' => 'N'], 'type' => 'string', 'required' => false, 'example' => 'Y:传入自定义参数 N:不传参数', 'title' => '', ], ], [ 'name' => 'Params', 'in' => 'query', 'style' => 'json', 'schema' => ['description' => 'The custom pass-through parameters.', 'type' => 'object', 'required' => false, 'example' => '{"testEmail":"wy****999@alibaba-inc.com"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'RequestId' => ['description' => 'The request ID. Alibaba Cloud generates a unique identifier for each request. You can use the request ID to troubleshoot issues.', 'type' => 'string', 'example' => 'ewtrew-fghdfg43564ZZ', 'title' => ''], 'Data' => ['description' => 'The result details of the monitoring task.', 'type' => 'object', 'example' => 'True', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Modify campaign information', 'summary' => 'Modifies campaign information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateMarketingFLow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdatePhoneEncryptionPublicKey' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '201015', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. You can view the phone number on the'."\n" .'[**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)> **Manage** > **WABA Management** > **Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86158********', 'title' => ''], ], [ 'name' => 'EncryptionPublicKey', 'in' => 'query', 'schema' => ['description' => 'The public key.', 'type' => 'string', 'required' => true, 'example' => '-----BEGIN PUBLIC KEY-----\\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAt+PMrYw4zUDEk+VeTrp0\\n8LZaoVpiVFErX7iuoDjUs4F9vkxMQuIABjcXw\\/swzTMEopLORQV28uqN\\/2\\/x9hjU\\****\\/Zwa\\/Vk5Svp4\\niVY4e22FsJCCWUEMvayO8Q+3UGq0eXXQ+8SlUWEMq1VaJ4pwCLsMnmgybA+VmJxi\\nkwIDAQAB\\n-----END PUBLIC KEY-----"', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)'."\n" .'page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A94866411B2O'."\n", 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Update the encryption public key of a phone number', 'summary' => 'Updates the encryption public key of a phone number.', 'description' => '- Before calling this operation, make sure that a phone number has been added under your WABA and has passed phone number verification.'."\n" .'- If no phone number has been added under your WABA, call the [GetChatappVerifyCode](~~600746~~) and [ChatappVerifyAndRegister](~~600770~~) operations to obtain a verification code and register a phone number.'."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, API calls are throttled, which may affect your business. Call this operation as appropriate.', 'changeSet' => [ ['createdAt' => '2025-07-14T07:56:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:52.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneEncryptionPublicKey'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneEncryptionPublicKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A94866411B2O\\\\n\\",\\n \\"Message\\": \\"None\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'UpdatePhoneMessageQrdl' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '200919', 'abilityTreeNodes' => ['FEATUREcamsU2M7I2'], ], 'parameters' => [ [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number. You can view the phone number on the'."\n" .'[**Channel Management**](https://chatapp.console.aliyun.com/ChannelsManagement)'."\n" .'[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList)> **Management** > **WABA Management** > **Number Management** page.', 'type' => 'string', 'required' => true, 'example' => '86158********', 'title' => ''], ], [ 'name' => 'GenerateQrImage', 'in' => 'query', 'schema' => ['description' => 'The type of the generated image. Valid values:'."\n" ."\n" .'- PNG'."\n" ."\n" .' - SVG', 'type' => 'string', 'required' => true, 'example' => 'SVG', 'title' => ''], ], [ 'name' => 'PrefilledMessage', 'in' => 'query', 'schema' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'Hello', 'title' => ''], ], [ 'name' => 'QrdlCode', 'in' => 'query', 'schema' => ['description' => 'The QR code encoding. This is the QrdlCode returned when you called the [CreatePhoneMessageQrdl](~~2638749~~) operation.', 'type' => 'string', 'required' => true, 'example' => 'D9II3***', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID of the ISV sub-customer or the instance ID of the direct customer. You can view the Space ID on the'."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => false, 'example' => 'cams-kei****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denial details.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1612C226-E271-4CFE-9F18-4066D******', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'QrImageUrl' => ['description' => 'The QR code image URL.', 'type' => 'string', 'example' => 'https://img.png', 'title' => ''], 'PhoneNumber' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '86158********', 'title' => ''], 'QrdlCode' => ['description' => 'The QR code encoding.', 'type' => 'string', 'example' => 'D9AA3***'."\n", 'title' => ''], 'DeepLinkUrl' => ['description' => 'The deep link URL.', 'type' => 'string', 'example' => 'https://wa.msg/', 'title' => ''], 'GenerateQrImage' => ['description' => 'The type of the generated image.', 'type' => 'string', 'example' => 'PNG', 'title' => ''], 'PrefilledMessage' => ['description' => 'The message content.', 'type' => 'string', 'example' => 'Hello', 'title' => ''], ], 'example' => '', 'title' => '', ], 'Code' => ['description' => 'The error code. For more information, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Modify a message QR code', 'summary' => 'Modifies a message QR code.', 'description' => '- After you modify a message QR code, users can no longer open the corresponding business phone number by scanning the original QR code. Proceed with caution.'."\n" ."\n" .'- Before calling this operation, make sure that you have created a message QR code.'."\n" ."\n" .'- If you have not created a message QR code, call the [CreatePhoneMessageQrdl](~~2638749~~) operation to create one first.'."\n" ."\n" .'#### QPS limit'."\n" .'The single-user QPS limit for this operation is 5 calls per second. If this limit is exceeded, the API calls are throttled, which may affect your business. Call this operation as needed.', 'changeSet' => [ ['createdAt' => '2025-07-14T05:50:46.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-26T05:51:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneMessageQrdl'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], 'UpdatePhoneWebhook' => [ 'methods' => ['get', 'post'], 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ 'APP' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '162635', 'abilityTreeNodes' => ['FEATUREcamsDJ746K'], ], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The SpaceId of the ISV sub-customer.', 'type' => 'string', 'required' => true, 'example' => '293483938849493****', 'title' => ''], ], [ 'name' => 'HttpFlag', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use HTTP to receive receipts. Valid values:'."\n" ."\n" .'- Y: Yes.'."\n" ."\n" .'- N: No.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ 'name' => 'QueueFlag', 'in' => 'query', 'schema' => ['description' => 'Specifies whether to use a queue to receive receipts. Valid values:'."\n" ."\n" .'- Y: Yes.'."\n" ."\n" .'- N: No.', 'type' => 'string', 'required' => false, 'example' => 'N', 'title' => ''], ], [ 'name' => 'PhoneNumber', 'in' => 'query', 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'example' => '861380000****', 'title' => ''], ], [ 'name' => 'StatusCallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL for the HTTP-based status report.', 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com', 'title' => ''], ], [ 'name' => 'UpCallbackUrl', 'in' => 'query', 'schema' => ['description' => 'The callback URL for the HTTP-based upstream message.', 'type' => 'string', 'required' => false, 'example' => 'http://aliyun.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The access denied details.', 'type' => 'string', 'example' => '无', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', 'title' => ''], 'Message' => ['description' => 'The prompt message. This parameter is returned when an exception occurs.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], ], 'title' => '', 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorMessage' => 'You have not subscribed to the specified product.', 'errorCode' => 'Product.Unsubscript', 'description' => 'You have not subscribed to the specified product.'], ['errorMessage' => 'You are not authorized to perform the operation.', 'errorCode' => 'Ram.PermissionDeny', 'description' => ''], ['errorMessage' => 'The system is under flow control.', 'errorCode' => 'System.LimitControl', 'description' => 'The system is under flow control.'], ['errorMessage' => 'The resource does not belong to the current user.', 'errorCode' => 'Unknown.ResourceOwnerId', 'description' => 'The resource does not belong to the current user.'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'title' => 'Modify phone number callback URL information', 'summary' => 'Modifies the callback URL information for a phone number.', 'description' => 'The per-user QPS limit for this API is 10 calls per second. If the limit is exceeded, API calls will be throttled, which may affect your business. Call this API at a reasonable frequency.', 'changeSet' => [ ['createdAt' => '2025-07-11T05:54:05.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2023-07-04T11:30:40.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneWebhook'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneWebhook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"null\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', ], 'UpdateWabaMmlStatus' => [ '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' => '示例值', 'title' => ''], ], [ 'name' => 'Code', 'in' => 'query', 'schema' => ['description' => 'The Meta embedded authorization code.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The space ID or instance ID of the ISV sub-customer, which is the channel ID. You can view it on the [Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement) page.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '1', 'title' => ''], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK indicates that the request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" ."\n" .'- true: Successful.'."\n" ."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Update MML status after MML embedding is complete', 'summary' => 'Updates the MML status of a WABA.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateWabaMmlStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值\\",\\n \\"Model\\": 1,\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], 'WhatsappCall' => [ 'summary' => 'Places, answers, or ends WhatsApp voice calls.', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => false, 'notSupportAutoTestReason' => '语音需要呼出', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'CustSpaceId', 'in' => 'query', 'schema' => ['description' => 'The Space ID of the ISV sub-customer, or the instance ID of the direct customer. View the Space ID on the'."\n" ."\n" .'[Channel Management](https://chatapp.console.aliyun.com/ChannelsManagement)[Channel Management](https://chatapp.console.alibabacloud.com/CustomerList) page.', 'type' => 'string', 'required' => true, 'example' => 'cams-xx**', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'query', 'schema' => ['description' => 'The call ID.', 'type' => 'string', 'required' => false, 'example' => 'wamid-xx**', 'title' => ''], ], [ 'name' => 'CallAction', 'in' => 'query', 'schema' => [ 'description' => 'The action to perform on the call.', 'enumValueTitles' => ['reject' => '', 'terminate' => '', 'pre_accept' => '', 'connect' => '', 'accept' => ''], 'type' => 'string', 'required' => true, 'example' => 'connect', 'title' => '', ], ], [ 'name' => 'BusinessNumber', 'in' => 'query', 'schema' => ['description' => 'The business number.', 'type' => 'string', 'required' => true, 'example' => '86138***', 'title' => ''], ], [ 'name' => 'UserNumber', 'in' => 'query', 'schema' => ['description' => 'The user\'s number.', 'type' => 'string', 'required' => false, 'example' => '86131***', 'title' => ''], ], [ 'name' => 'Session', 'in' => 'query', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'SdpType' => [ 'description' => 'The type of the SDP payload.', 'enumValueTitles' => ['offer' => '', 'answer' => ''], 'type' => 'string', 'required' => false, 'example' => 'offer', 'title' => '', ], 'Sdp' => ['description' => 'The Session Description Protocol (SDP) payload used for call negotiation.', 'type' => 'string', 'required' => false, 'example' => 'v=0\\r\\no=- 3978582128 3978582128 IN IP4 0.0.0.0\\r\\ns=Kurento Media Server\\r\\nc=IN IP4 0.0.0.0\\r\\nt=0 0\\r\\na=group:BUNDLE audio0\\r\\nm=audio 61903 RTP/SAVPF 96 0 8\\r\\na=setup:actpass\\r\\na=extmap:3 http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time\\r\\na=rtpmap:96 opus/48000/2\\r\\na=rtcp:9 IN IP4 0.0.0.0\\r\\na=rtcp-mux\\r\\na=sendrecv\\r\\na=mid:audio0\\r\\na=ssrc:1935711036 cname:user3617531270@host-126a650\\r\\na=ice-ufrag:/TW8\\r\\na=ice-pwd:GRKrVHYTLGT69PYlqqWQHO\\r\\na=fingerprint:sha-256 41:5C:01:6E:C0:1B:21:F1:0D:28:95:2E:4E:42:F6:64:F3:DB:DD:E3:18:54:32:28:3D:2F:9C:80:38:FA:E0:2Ca=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\\r\\na=candidate:candidate:1 1 UDP 2015363327 47.243.79.43 46008 typ host\\r\\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\\r\\na=candidate:candidate:3 1 TCP 1010827519 47.243.79.43 32450 typ host tcptype passive\\r\\na=candidate:candidate:2 1 TCP 1015021823 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\\r\\na=candidate:candidate:4 1 UDP 2015363583 fe80::216:3eff:fe22:644f 12231 typ host\\r\\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:5 1 TCP 1015022079 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\\r\\na=candidate:candidate:6 1 TCP 1010827775 fe80::216:3eff:fe22:644f 6988 typ host tcptype passive\\r\\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\\r\\na=candidate:candidate:1 2 UDP 2015363326 47.243.79.43 40782 typ host\\r\\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:2 2 TCP 1015021822 47.243.79.43 9 typ host tcptype active\\r\\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\\r\\na=candidate:candidate:3 2 TCP 1010827518 47.243.79.43 64559 typ host tcptype passive\\r\\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\\r\\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:4 2 UDP 2015363582 fe80::216:3eff:fe22:644f 39166 typ host\\r\\na=candidate:candidate:5 2 TCP 1015022078 fe80::216:3eff:fe22:644f 9 typ host tcptype active\\r\\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\\r\\na=candidate:candidate:6 2 TCP 1010827774 fe80::216:3eff:fe22:644f 16286 typ host tcptype passive\\r\\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:7 1 UDP 1679819007 47.243.79.43 46008 typ srflx raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:8 1 TCP 847249663 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\\r\\na=candidate:candidate:9 1 TCP 843055359 47.243.79.43 32450 typ srflx raddr 172.22.181.115 rport 32450 tcptype passive\\r\\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:10 1 UDP 505413887 47.243.79.43 61903 typ relay raddr 172.22.181.115 rport 46008\\r\\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:7 2 UDP 1679819006 47.243.79.43 40782 typ srflx raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:8 2 TCP 847249662 47.243.79.43 9 typ srflx raddr 172.22.181.115 rport 9 tcptype active\\r\\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\\r\\na=candidate:candidate:9 2 TCP 843055358 47.243.79.43 64559 typ srflx raddr 172.22.181.115 rport 64559 tcptype passive\\r\\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\\r\\na=candidate:candidate:10 2 UDP 505413886 47.243.79.43 63580 typ relay raddr 172.22.181.115 rport 40782\\r\\n'."\n", 'title' => ''], ], 'required' => false, 'example' => '', 'description' => 'The call negotiation information.', 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => ['description' => 'Details about the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xik-x**', 'title' => ''], 'Model' => [ 'type' => 'object', 'properties' => [ 'CallId' => ['description' => 'The unique identifier for each call.', 'type' => 'string', 'example' => 'wamid-xx**', 'title' => ''], ], 'description' => 'The returned result.', 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The request status code.'."\n" ."\n" .'- OK: The request was successful.'."\n" ."\n" .'- For other error codes, see [Error codes](~~196974~~).', 'type' => 'string', 'example' => 'OK', 'title' => ''], 'Success' => ['description' => 'Indicates whether the call was successful.'."\n" ."\n" .'- **true**: The call was successful.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'WhatsappCall', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', ], ], 'endpoints' => [ ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'cams.ap-southeast-1.aliyuncs.com', 'endpoint' => 'cams.ap-southeast-1.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => '0000', 'message' => 'The operation is successful.', 'http_code' => 200, 'description' => 'The operation is successful.'], ['code' => '999999', 'message' => 'System Exception. Please refresh the page and try again', 'http_code' => 400, 'description' => 'System Exception. Please refresh the page and try again'], ['code' => 'CHAT.APIError', 'message' => 'You are not authorized to do this operation.', 'http_code' => 500, 'description' => 'System internal error'], ['code' => 'DetailError.TemplateNotExist', 'message' => 'The template is not exist.', 'http_code' => 400, 'description' => 'This template does not exist'], ['code' => 'ERR-COMMON-001', 'message' => 'System exception, please contact administrator.', 'http_code' => 500, 'description' => 'System exception, please contact administrator'], ['code' => 'ERR-FB-001', 'message' => 'Unsupported get request. Does not exist, cannot be loaded due to missing permissions, Or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api.', 'http_code' => 400, 'description' => 'The GET request method is not supported, cannot be loaded due to lack of permissions, or the operation is not supported. Read the Graph API documentation at https://developers.facebook.com/docs/graph-api.'], ['code' => 'ERR-OPERATION-MAAP-0060', 'message' => 'The subscriber has not bind WABA.', 'http_code' => 400, 'description' => 'The subscriber has not bind WABA.'], ['code' => 'ERR-OPERATION-MAAP-0065', 'message' => 'The phoneCode is not bind to the subscriber.', 'http_code' => 400, 'description' => 'This number is not bound to the current subscriber.'], ['code' => 'ERR-OPERATION-MAAP-0085', 'message' => 'The website url must start with http or https.', 'http_code' => 400, 'description' => 'Website URLs must begin with http or https.'], ['code' => 'ERR-OPERATION-MAAP-0090', 'message' => 'The WABA review status is rejected.', 'http_code' => 400, 'description' => 'The WABA review status is rejected.'], ['code' => 'ERR-OPERATION-MAAP-0113', 'message' => 'The waba has been used by other customer.', 'http_code' => 400, 'description' => 'The waba has been used by other customer.'], ['code' => 'ERR-OPERATION-PROCESS-067', 'message' => 'The account has been suspended due to arrears.', 'http_code' => 400, 'description' => 'The account has been suspended due to arrears.'], ['code' => 'ERR-OPERATION-PROCESS-068', 'message' => 'The ISV account has been suspended due to arrears.', 'http_code' => 400, 'description' => 'The ISV account has been suspended due to arrears.'], ['code' => 'ERR-REST-001', 'message' => 'System exception.', 'http_code' => 500, 'description' => 'System exception'], ['code' => 'ERR-REST-001', 'message' => 'Cannot be loaded due to missing permissions, or does not support this operation.', 'http_code' => 403, 'description' => 'No permission'], ['code' => 'HETU-ERR-LOGIN-001', 'message' => 'The current user does not have permission for this interface.', 'http_code' => 400, 'description' => 'The current user does not have permission for this interface.'], ['code' => 'HETU-ERR-SUBSCRIBER-035', 'message' => 'The product code is error.', 'http_code' => 400, 'description' => 'The product code is error.'], ['code' => 'InvalidParameter', 'message' => 'Must not be null.', 'http_code' => 400, 'description' => 'cannot be empty'], ['code' => 'InvalidParameter.Auth', 'message' => 'You have not the permission to request the interface.', 'http_code' => 400, 'description' => 'You have not the permission to request the interface.'], ['code' => 'InvalidParameter.AuthenticationButtonNotEmpty', 'message' => 'The buttons can not be empty when category is Authentication.', 'http_code' => 400, 'description' => 'The buttons can not be empty when category is Authentication.'], ['code' => 'InvalidParameter.ButtonUrlError', 'message' => 'The button url error.', 'http_code' => 400, 'description' => 'The button url error.'], ['code' => 'InvalidParameter.ChannelTypeNotSupport', 'message' => 'The channel type is not support.', 'http_code' => 400, 'description' => 'The channel type is not supported.'], ['code' => 'InvalidParameter.ComponentsBodyNotNull', 'message' => 'The content can not be empty when component type is BODY.', 'http_code' => 400, 'description' => 'The content can not be empty when component type is BODY.'], ['code' => 'InvalidParameter.ComponentsHeaderUrlNotEmpty', 'message' => 'The url can not be empty when component type is HEADER and format is not TEXT.', 'http_code' => 400, 'description' => 'The header Url in the message template cannot be empty.'], ['code' => 'InvalidParameter.ContentError', 'message' => 'The content invalid, please consult the interface document.', 'http_code' => 400, 'description' => 'The content invalid, please consult the interface document.'], ['code' => 'InvalidParameter.ContentNotEmpty', 'message' => 'The content can not be empty when type is message.', 'http_code' => 400, 'description' => 'The content can not be empty when type is message.'], ['code' => 'InvalidParameter.ContentNull', 'message' => 'Content can not has value when type is template.', 'http_code' => 400, 'description' => 'Content can not has value when type is template.'], ['code' => 'InvalidParameter.FailBackContentNotNull', 'message' => 'The FailBackContent can not be empty when FailBackId is not empty.', 'http_code' => 400, 'description' => 'The FailBackContent can not be empty when FailBackId is not empty.'], ['code' => 'InvalidParameter.FailBackContentNull', 'message' => 'The FailBackContent can not have value when FailBackId is empty.', 'http_code' => 400, 'description' => 'When the FailBackId is empty, the FailBackContent is not allowed to have a value.'], ['code' => 'InvalidParameter.FailBackRuleError', 'message' => 'The failBackRule is error.', 'http_code' => 400, 'description' => 'The failBackRule is error.'], ['code' => 'InvalidParameter.FileUrlError', 'message' => 'The file can not download.', 'http_code' => 400, 'description' => 'This file could not be downloaded.'], ['code' => 'InvalidParameter.FlowActionMustEmpty', 'message' => 'The flowAction can not be empty.', 'http_code' => 400, 'description' => 'The flowAction can not be empty.'], ['code' => 'InvalidParameter.FromError', 'message' => 'Can not find the from value.', 'http_code' => 400, 'description' => 'Value from not found'], ['code' => 'InvalidParameter.FromErrorStatus', 'message' => 'From status can not to send.', 'http_code' => 400, 'description' => 'From status can not to send.'], ['code' => 'InvalidParameter.FromOnlyNumeric', 'message' => 'From is only entry number.', 'http_code' => 400, 'description' => 'From is only entry number.'], ['code' => 'InvalidParameter.InteractiveBodyError', 'message' => 'The interactive message body is error.', 'http_code' => 400, 'description' => 'The interactive message body is error.'], ['code' => 'InvalidParameter.IsvCodeError', 'message' => 'The isvCode is error.', 'http_code' => 400, 'description' => 'The isvCode is error.'], ['code' => 'InvalidParameter.IsvCodeNotEmpty', 'message' => 'The isvCode can not be empty.', 'http_code' => 400, 'description' => 'The isvCode can not be empty.'], ['code' => 'InvalidParameter.LanguageNotSupport', 'message' => 'The language is not support.', 'http_code' => 400, 'description' => 'The language is not support.'], ['code' => 'InvalidParameter.MessageInvalid2', 'message' => 'Template can not contain.', 'http_code' => 400, 'description' => 'String information of $(\\d) is not allowed in the message body'], ['code' => 'InvalidParameter.MessageTypeNotSupport', 'message' => 'The message type is not support.', 'http_code' => 400, 'description' => 'The message type is not support.'], ['code' => 'InvalidParameter.MessageTypeNull', 'message' => 'Message type can not have value when type is template.', 'http_code' => 400, 'description' => 'Message type can not have value when type is template.'], ['code' => 'InvalidParameter.NoSmsChannel', 'message' => 'The SMS sending channel has not been opened.', 'http_code' => 400, 'description' => 'The SMS sending channel has not been opened.'], ['code' => 'InvalidParameter.NotSub', 'message' => 'Can not use the RAM account to request the interface.', 'http_code' => 403, 'description' => 'Can not use the RAM account to request the interface.'], ['code' => 'InvalidParameter.TemplateAuditNotPass', 'message' => 'The template has not approved.', 'http_code' => 400, 'description' => 'The template has not approved.'], ['code' => 'InvalidParameter.TemplateAuditPass', 'message' => 'The template has been approved, can only edit templates in approved status up to 10 times within 30 consecutive days (or once every 24 hours).', 'http_code' => 200, 'description' => 'The template has been approved, can only edit templates in approved status up to 10 times within 30 consecutive days (or once every 24 hours).'], ['code' => 'InvalidParameter.TemplateCodeNotEmpty', 'message' => 'The template code can not be empty.', 'http_code' => 400, 'description' => 'The template code can not be empty.'], ['code' => 'InvalidParameter.TemplateNameExist', 'message' => 'A template with the same name and language already exists.', 'http_code' => 400, 'description' => 'A template with the same name and language already exists.'], ['code' => 'InvalidParameter.TemplateNoneParams', 'message' => 'The template does not have parameter.', 'http_code' => 400, 'description' => 'This message template variable is empty'], ['code' => 'InvalidParameter.TemplateParamsNotMatch', 'message' => 'Template params error, parameter name:.', 'http_code' => 400, 'description' => 'Template params error, parameter name:'], ['code' => 'InvalidParameter.ToOnlyNumeric', 'message' => 'To is only entry number.', 'http_code' => 400, 'description' => 'To is only entry number.'], ['code' => 'InvalidParameter.ToRestricted', 'message' => 'Prohibit sending in to country.', 'http_code' => 400, 'description' => 'Prohibit sending by sender\'s country'], ['code' => 'InvalidParameter.TypeNotSupport', 'message' => 'The type is not support.', 'http_code' => 400, 'description' => 'The type is not support.'], ['code' => 'InvalidParameter.WhatsappCategoryNotSupport', 'message' => 'The category is standard values are UTILITY or MARKETING or AUTHENTICATION.', 'http_code' => 400, 'description' => 'The category is standard values are UTILITY or MARKETING or AUTHENTICATION'], ['code' => 'InvalidParameters', 'message' => 'The specified parameter values are invalid.', 'http_code' => 400, 'description' => 'The specified parameter values are invalid.'], ['code' => 'InvalidResourceGroup', 'message' => 'The specified ResourceGroupId is invalid.', 'http_code' => 400, 'description' => 'The specified ResourceGroupId is invalid.'], ['code' => 'Isp.AUTH', 'message' => 'You have no right to take this operation.', 'http_code' => 403, 'description' => 'You have no right to take this operation.'], ['code' => 'Isp.HTTP_ERROR', 'message' => 'Third-party error information, unified error code.', 'http_code' => 400, 'description' => 'Third-party error information, unified error code'], ['code' => 'MissingParameter.ResourceGroupId', 'message' => 'The ResourceGroupId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'The ResourceGroupId parameters that are required for processing this request are missing.'], ['code' => 'MissingParameter.ResourceId', 'message' => 'The ResourceId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'The ResourceId parameters that are required for processing this request are missing.'], ['code' => 'MissingParameter.ResourceRegionId', 'message' => 'The ResourceRegionId parameters that are required for processing this request are missing.', 'http_code' => 400, 'description' => 'The ResourceRegionId parameters that are required for processing this request are missing.'], ['code' => 'NoPermission.ChangeResourceGroup', 'message' => 'You are not authorized to change resource group.', 'http_code' => 400, 'description' => 'You are not authorized to change resource group.'], ['code' => 'Product.Unsubscript', 'message' => 'You have not subscribed to the specified product.', 'http_code' => 400, 'description' => 'You have not subscribed to the specified product.'], ['code' => 'Ram.PermissionDeny', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 400, 'description' => ''], ['code' => 'ResourceNotFound', 'message' => 'The specified resource is not found.', 'http_code' => 400, 'description' => ' The specified resource is not found.'], ['code' => 'SendMessage.Error', 'message' => 'Send message failed.', 'http_code' => 500, 'description' => 'Failed to send message'], ['code' => 'System.LimitControl', 'message' => 'The system is under flow control.', 'http_code' => 400, 'description' => 'The system is under flow control.'], ['code' => 'SystemError', 'message' => 'A system error occurred while processing your request.', 'http_code' => 400, 'description' => 'A system error occurred while processing your request.'], ['code' => 'Unknown.ResourceOwnerId', 'message' => 'The resource does not belong to the current user.', 'http_code' => 400, 'description' => 'The resource does not belong to the current user.'], ['code' => 'You are not authorized to do this operation', 'message' => 'You are not authorized to perform this operation.', 'http_code' => 403, 'description' => 'You are not authorized to perform this operation.'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SendChatappMessage'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMassMessage'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMassMessage'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMessage'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMassMessage'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2026-02-27T07:44:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'UpdateFlowJSONAsset'], ], 'createdAt' => '2026-01-14T01:42:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2025-09-15T02:20:42.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2025-07-30T07:56:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ChatappEmbedSignUp'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ChatappMigrationRegister'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateChatappMigrationInitiate'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeprecateFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetFlowJSONAssest'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetPhoneEncryptionPublicKey'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'IsvGetAppId'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'PublishFlow'], ], 'createdAt' => '2025-07-14T07:56:31.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreatePhoneMessageQrdl'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'EnableWhatsappROIMetric'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetChatappTemplateMetric'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetFlowPreviewUrl'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetPermissionByCode'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateFlowJSONAsset'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdatePhoneMessageQrdl'], ], 'createdAt' => '2025-07-14T05:51:15.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ChatappMigrationVerified'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ChatappPhoneNumberDeregister'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeletePhoneMessageQrdl'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetChatappPhoneNumberMetric'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetChatappUploadAuthorization'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetMigrationVerifyCode'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetPhoneNumberVerificationStatus'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SubmitIsvCustomerTerms'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateAccountWebhook'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdatePhoneWebhook'], ], 'createdAt' => '2025-07-11T05:54:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListPhoneMessageQrdl'], ], 'createdAt' => '2025-07-10T08:52:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'BeeBotAssociate'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'BeeBotChat'], ], 'createdAt' => '2025-07-03T02:41:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2025-06-24T09:46:38.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2025-06-11T13:06:01.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ], 'createdAt' => '2025-04-22T10:09:40.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2025-04-21T11:37:07.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryChatappPhoneNumbers'], ], 'createdAt' => '2025-04-07T06:36:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'CreateFlow'], ['description' => 'Request parameters changed', 'api' => 'CreatePhoneMessageQrdl'], ['description' => 'Request parameters changed', 'api' => 'DeleteChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'DeleteFlow'], ['description' => 'Request parameters changed', 'api' => 'DeletePhoneMessageQrdl'], ['description' => 'Request parameters changed', 'api' => 'DeprecateFlow'], ['description' => 'Request parameters changed', 'api' => 'EnableWhatsappROIMetric'], ['description' => 'Request parameters changed', 'api' => 'GetChatappPhoneNumberMetric'], ['description' => 'Request parameters changed', 'api' => 'GetChatappTemplateDetail'], ], 'createdAt' => '2025-03-26T05:52:21.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryWabaBusinessInfo'], ], 'createdAt' => '2025-02-26T09:22:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2024-12-02T02:33:56.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ChatappEmbedSignUp'], ['description' => 'Response parameters changed', 'api' => 'ChatappMigrationRegister'], ['description' => 'Response parameters changed', 'api' => 'ChatappMigrationVerified'], ], 'createdAt' => '2024-11-06T12:50:45.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddChatappPhoneNumber'], ], 'createdAt' => '2024-09-05T03:40:55.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'ListChatappTemplate'], ], 'createdAt' => '2024-07-24T10:39:12.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2024-06-21T01:24:26.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ListChatappTemplate'], ], 'createdAt' => '2024-05-29T12:04:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteFlow'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListFlow'], ], 'createdAt' => '2024-04-26T03:25:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'DeleteChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyPhoneBusinessProfile'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryChatappPhoneNumbers'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'QueryPhoneBusinessProfile'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2024-04-10T09:38:34.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2024-03-14T03:24:57.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2023-11-22T08:58:36.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'IsvGetAppId'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2023-11-21T13:09:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2023-10-19T06:42:05.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2023-09-21T09:48:37.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Response parameters changed', 'api' => 'ListChatappTemplate'], ], 'createdAt' => '2023-09-14T12:02:03.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2023-08-17T12:01:27.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2023-08-01T14:41:44.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'BeeBotAssociate'], ['description' => 'Response parameters changed', 'api' => 'BeeBotChat'], ['description' => 'Response parameters changed', 'api' => 'ChatappBindWaba'], ['description' => 'Response parameters changed', 'api' => 'ChatappEmbedSignUp'], ['description' => 'Response parameters changed', 'api' => 'ChatappMigrationRegister'], ['description' => 'Response parameters changed', 'api' => 'ChatappMigrationVerified'], ['description' => 'Response parameters changed', 'api' => 'ChatappPhoneNumberRegister'], ['description' => 'Response parameters changed', 'api' => 'ChatappSyncPhoneNumber'], ['description' => 'Response parameters changed', 'api' => 'ChatappVerifyAndRegister'], ['description' => 'Response parameters changed', 'api' => 'CreateChatappMigrationInitiate'], ], 'createdAt' => '2023-07-04T11:34:06.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ], 'createdAt' => '2023-05-25T12:54:20.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2023-05-08T11:38:32.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendChatappMassMessage'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2023-04-13T11:48:18.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'IsvGetAppId'], ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'ListChatappTemplate'], ], 'createdAt' => '2023-03-29T01:41:08.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ModifyChatappTemplate'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2023-03-24T08:25:18.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-12-27T06:22:48.000Z', 'description' => '发布超时导致接口异常', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'QueryChatappPhoneNumbers'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-12-21T02:07:22.000Z', 'description' => '通过北向接口做嵌入式', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ], 'createdAt' => '2022-11-17T11:49:39.000Z', 'description' => 'ISV主账号发送时新增custSpaceId，用作主账号调用子客户的接口权限新增查询Waba信息，号码信息接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BeeBotAssociate'], ['description' => 'Request parameters changed', 'api' => 'BeeBotChat'], ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'DeleteChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'GetChatappTemplateDetail'], ['description' => 'Request parameters changed', 'api' => 'ListChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'ModifyChatappTemplate'], ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-11-17T10:08:32.000Z', 'description' => '新增查询Waba信息，号码信息接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'BeeBotAssociate'], ['description' => 'Request parameters changed', 'api' => 'BeeBotChat'], ], 'createdAt' => '2022-10-12T01:57:41.000Z', 'description' => '修复接口入参拼写错误', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMassMessage'], ], 'createdAt' => '2022-09-30T07:06:02.000Z', 'description' => 'SendChatappMassMessage接口更新模板编码和模板语言为必填', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ModifyChatappTemplate'], ], 'createdAt' => '2022-09-29T08:00:43.000Z', 'description' => '添加云小蜜相关支持接口，添加模板修改接口', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-09-20T06:32:49.000Z', 'description' => '支持ISV参数', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'SendChatappMassMessage'], ], 'createdAt' => '2022-08-18T12:13:52.000Z', 'description' => '支持消息群发', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-07-15T09:54:03.000Z', 'description' => '支持ChatApp消息回落短信', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'CreateChatappTemplate'], ], 'createdAt' => '2022-06-21T09:21:04.000Z', 'description' => '创建模板接口，components参数设置为必填', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetChatappTemplateDetail'], ], 'createdAt' => '2022-05-11T08:25:46.000Z', 'description' => '新增返回参数', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'GetChatappOpenStatus'], ], 'createdAt' => '2022-03-28T07:33:07.000Z', 'description' => 'ChatApp 添加开通/查询开通状态接口', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CheckChatappContacts'], ['description' => 'OpenAPI offline', 'api' => 'SendChatappMessage'], ], 'createdAt' => '2022-03-24T03:17:02.000Z', 'description' => 'ChatApp 添加新的消息发送和联系人查询接口', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'CreateChatappTemplate'], ['description' => 'OpenAPI offline', 'api' => 'DeleteChatappTemplate'], ['description' => 'OpenAPI offline', 'api' => 'GetChatappTemplateDetail'], ['description' => 'OpenAPI offline', 'api' => 'ListChatappTemplate'], ], 'createdAt' => '2022-03-10T06:25:54.000Z', 'description' => '新增模板管控接口', ], [ 'apis' => [ ['description' => 'OpenAPI offline', 'api' => 'ListHref'], ], 'createdAt' => '2022-02-22T11:34:04.000Z', 'description' => 'ChatApp新版本控制台后端接口上线', ], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '75', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappPhoneNumberMetric'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWhatsappHealthStatus'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateFlow'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAccountWebhook'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListFlow'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyChatappTemplate'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateCommerceSetting'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowPreviewUrl'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPreValidatePhoneId'], ['threshold' => '150', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappTemplateDetail'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChatappTemplate'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyPhoneBusinessProfile'], ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappSyncPhoneNumber'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPhoneEncryptionPublicKey'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappTemplateMetric'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePhoneMessageQrdl'], ['threshold' => '250', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendChatappMessage'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneMessageQrdl'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappPhoneNumberRegister'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetWhatsappConnectionCatalog'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableWhatsappROIMetric'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlowJSONAssest'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappUploadAuthorization'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetChatappVerifyCode'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneEncryptionPublicKey'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TriggerChatFlow'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateFlowJSONAsset'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConversationalAutomation'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'IsvGetAppId'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPhoneMessageQrdl'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommerceSetting'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePhoneMessageQrdl'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatappMigrationInitiate'], ['threshold' => '1', 'countWindow' => 20, 'regionId' => '*', 'api' => 'QueryWabaBusinessInfo'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateChatappTemplate'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProduct'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatappPhoneNumbers'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddChatappPhoneNumber'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappMigrationVerified'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProductCatalog'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPhoneBusinessProfile'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMigrationVerifyCode'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappPhoneNumberDeregister'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ModifyFlow'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitIsvCustomerTerms'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPhoneNumberVerificationStatus'], ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendChatappMassMessage'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteFlow'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeprecateFlow'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappBindWaba'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappMigrationRegister'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateConversationalAutomation'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteChatappTemplate'], ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePhoneWebhook'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPermissionByCode'], ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChatappVerifyAndRegister'], ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishFlow'], ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryChatappBindWaba'], ], ], 'ram' => [ 'productCode' => 'ChatAppMessageService', 'productName' => 'Chat App Message Service', 'ramCodes' => ['cams'], 'ramLevel' => 'RESOURCE', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'BindInstagramPage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:BindInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFlowNodeGroup', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowNodeGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFlowJSONAssest', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlowJSONAssest', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatGroup', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EnableWhatsappROIMetric', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:EnableWhatsappROIMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncMessengerSubscriptionToken', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:SyncMessengerSubscriptionToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateWhatsappConversionApi', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RemoveContactById', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:RemoveContactById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PublishFlow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:PublishFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyPhoneBusinessProfile', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ModifyPhoneBusinessProfile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstance', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'CreatePhoneMessageQrdl', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreatePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePhoneEncryptionPublicKey', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneEncryptionPublicKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetWhatsappHealthStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappHealthStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMarketingFlow', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDmAccount', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappPhoneNumberMetric', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappPhoneNumberMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteInstance', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ChatappBindWaba', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappBindWaba', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddChatappPhoneNumber', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:AddChatappPhoneNumber', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappTemplateMetric', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappTemplateMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FlowRebindPhone', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowRebindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddAuditViberOpen', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddAuditViberOpen', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'TriggerChatFlow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:TriggerChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendChatappMessage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SendChatappMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChangeResourceGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChangeResourceGroup', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteContacts', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteContacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPageAdAccount', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListPageAdAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatappTemplate', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappPhoneNumberDeregister', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappPhoneNumberDeregister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappPhoneNumberSetting', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappPhoneNumberSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeprecateFlow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeprecateFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateChatFlowLogSetting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncBusinessAppHistory', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateChatGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddAddressRecoverSuspend', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddAddressRecoverSuspend', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMarketingFlow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListWhatAppTemplate', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListWhatAppTemplate', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#CustSpaceId}'], ], ], ], [ 'apiName' => 'AddCustomAudienceUser', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddCustomAudienceUser', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PauseMarketingFLow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:PauseMarketingFLow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteChatGroupParticipants', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroupParticipants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateInstance', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/*'], ], ], ], [ 'apiName' => 'ListProduct', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListProduct', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFlowVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryChatappBindWaba', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryChatappBindWaba', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateContactById', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateContactById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCustomerSite', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetCustomerSite', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAuditRequestByTypeUnAudit', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetAuditRequestByTypeUnAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateInstance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'ListInstagramPosts', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstagramPosts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BindMessengerPage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:BindMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryInstance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryInstance', 'authLevel' => 'resource', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ], ], ], [ 'apiName' => 'GetChatappUploadAuthorization', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappUploadAuthorization', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateMessageCampaign', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UnbindDmAccount', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:UnbindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteChatFlow', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMessageCampaign', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateConversationalAutomation', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateConversationalAutomation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddContacts', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddContacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateAccountWebhook', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateAccountWebhook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'OpenChatappService', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:OpenChatappService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappVerifyCode', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappVerifyCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateChatappMigrationInitiate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatappMigrationInitiate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddChatGroupInviteLink', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddChatGroupInviteLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetViberByRequestNo', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetViberByRequestNo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFlowNodePrototypeV2', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowNodePrototypeV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFacebookPosts', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFacebookPosts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMessageCampaign', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GeneratePresignedUrl', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:GeneratePresignedUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddMarketingFlow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddMarketingFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'OfflineFlowVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:OfflineFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatFlowTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:GetChatFlowTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatFlowTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ListChatFlowTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateFlowJSONAsset', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateFlowJSONAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FlowUnbindPhone', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowUnbindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetMessageCampaignInsights', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetMessageCampaignInsights', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInstagramPage', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReadChatFlowLogSetting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BindDmAccount', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:BindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryWabaBusinessInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryWabaBusinessInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatappMessage', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatappMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFbInstagramPages', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFbInstagramPages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListProductCatalog', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListProductCatalog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteContactsByIds', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteContactsByIds', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetWhatsappConnectionCatalog', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappConnectionCatalog', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitVerifyCodeResult', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SubmitVerifyCodeResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDmTag', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListDmTag', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteChatGroupInviteLink', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroupInviteLink', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatFlow', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateFlowVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPhoneEncryptionPublicKey', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPhoneEncryptionPublicKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFlowPreviewUrl', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlowPreviewUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPhoneNumberVerificationStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPhoneNumberVerificationStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyChatappTemplate', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ModifyChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CheckDirectSendMessageSample', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:CheckDirectSendMessageSample', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateAuditRequest', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateAuditRequest', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateChatFlowLogSetting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:UpdateChatFlowLogSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteChatGroup', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePhoneMessageQrdl', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReadChatFlow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAutoGeneratedTemplate', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetAutoGeneratedTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappSyncPhoneNumber', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ChatappSyncPhoneNumber', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMarketingFLow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateMarketingFLow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncMessageCampaign', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:SyncMessageCampaign', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetGroupExist', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetGroupExist', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListBindDmAccount', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListBindDmAccount', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListChatGroupParticipants', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListChatGroupParticipants', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPreValidatePhoneId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPreValidatePhoneId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryChatappPhoneNumbers', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:QueryChatappPhoneNumbers', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddChatGroup', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:AddChatGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryPhoneBusinessProfile', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:QueryPhoneBusinessProfile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeletePhoneMessageQrdl', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeletePhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'MoveContactToGroup', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:MoveContactToGroup', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappMigrationRegister', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappMigrationRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPermissionByCode', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPermissionByCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateGroupName', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateGroupName', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ReadFlowVersion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ReadFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappPhoneNumberRegister', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappPhoneNumberRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDownloadExcelList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:GetDownloadExcelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteGroupById', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteGroupById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateCommerceSetting', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateCommerceSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListViberServiceMessage', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListViberServiceMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappTemplateDetail', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappTemplateDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCommerceSetting', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:GetCommerceSetting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateChatFlow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SyncFlow', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMessengerPage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateFlowVersion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFlowVersion', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'WhatsappCall', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'OnlineFlowVersion', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:OnlineFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateFlow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFlow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetViberPauseTimes', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetViberPauseTimes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModifyFlow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:ModifyFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetMigrationVerifyCode', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetMigrationVerifyCode', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateCustomAudience', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateCustomAudience', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomAudience', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListCustomAudience', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateChatappTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatFlowMetric', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatFlowMetric', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteInstagramPage', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:DeleteInstagramPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CopyTemplate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CopyTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMessengerSubscriptionToken', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListMessengerSubscriptionToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdatePhoneWebhook', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdatePhoneWebhook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappVerifyAndRegister', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappVerifyAndRegister', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateMessengerPage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateMessengerPage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateChatFlowByImport', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlowByImport', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetChatappOpenStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetChatappOpenStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SendChatappMassMessage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:SendChatappMassMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFlow', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:DeleteFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetConversationalAutomation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetConversationalAutomation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateWabaMmlStatus', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:UpdateWabaMmlStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RequestWhatsappConversionApi', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'cams:RequestWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAllGroups', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListAllGroups', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'IsvGetAppId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:IsvGetAppId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ChatappMigrationVerified', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:ChatappMigrationVerified', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPledgeTemplateAddress', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetPledgeTemplateAddress', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPhoneMessageQrdl', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:ListPhoneMessageQrdl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListBindingRelationsForFlowVersion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:ListBindingRelationsForFlowVersion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteChatappTemplate', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'cams:DeleteChatappTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateChatFlow', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'cams:CreateChatFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetWhatsappConversionApi', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetWhatsappConversionApi', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFbMessengerPages', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'cams:GetFbMessengerPages', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFlow', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'cams:ListFlow', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FlowBindPhone', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'cams:FlowBindPhone', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'ChatAppMessageService', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [ ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/*'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}'], ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:cams:{#regionId}:{#accountId}:instance/{#CustSpaceId}'], ], ], ];