diff options
Diffstat (limited to 'data/en_us/accountcenter')
| -rw-r--r-- | data/en_us/accountcenter/2024-12-09/api-docs.php | 1714 |
1 files changed, 1712 insertions, 2 deletions
diff --git a/data/en_us/accountcenter/2024-12-09/api-docs.php b/data/en_us/accountcenter/2024-12-09/api-docs.php index 19d0733..25634b2 100644 --- a/data/en_us/accountcenter/2024-12-09/api-docs.php +++ b/data/en_us/accountcenter/2024-12-09/api-docs.php @@ -1,4 +1,1714 @@ <?php return [ - 'code' => 500, - 'message' => 'server error', + 'version' => '1.0', + 'info' => ['style' => 'RPC', 'product' => 'AccountCenter', 'version' => '2024-12-09'], + 'directories' => [ + [ + 'children' => [ + 'SendAsyncMobileCaptcha', + 'SendAsyncEmailCaptcha', + [ + 'children' => ['EnterpriseContactQueryPageList', 'EnterpriseContactQueryDetail', 'EnterpriseContactEdit', 'EnterpriseContactDelete', 'EnterpriseContactAdd'], + 'type' => 'directory', + 'title' => 'Enterprise Contact Management', + ], + [ + 'children' => ['AccountContactQueryPageList', 'AccountContactQueryDetail', 'AccountContactEdit', 'AccountContactDelete', 'AccountContactAdd'], + 'type' => 'directory', + 'title' => 'Account Contact Management', + ], + ], + 'type' => 'directory', + 'title' => 'Contact Management', + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'AccountContactAdd' => [ + 'summary' => 'Creates an account contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email address of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xxx'], + ], + [ + 'name' => 'ContactMobile', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The mobile number of the contact.', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'], + ], + [ + 'name' => 'ContactPosition', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The position of the contact. Valid values:'."\n" + ."\n" + .'- TECH_MANAGER: technical manager'."\n" + .'- MAINTAIN_MANAGER: O&M manager'."\n" + .'- PROJECT_MANAGER: project manager'."\n" + .'- FINANCE_MANAGER: finance manager'."\n" + .'- OTHER: other.', + 'enumValueTitles' => ['TECH_MANAGER: technical manager.', 'MAINTAIN_MANAGER: O&M manager.', 'PROJECT_MANAGER: project manager.', 'FINANCE_MANAGER: finance manager.', 'CEO', 'OTHER: other.'], + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EmailCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'MobileCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The SMS verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the contact is a shared contact. This parameter is set to false by default in this operation.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AsyncEmailVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the email address. Set this parameter to true for API calls. Otherwise, the verification code is synchronously verified. Call the SendAsyncEmailCaptcha operation to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'AsyncMobileVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the mobile number. Set this parameter to true for API calls. Otherwise, the verification code is synchronously verified. Call the SendAsyncMobileCaptcha operation to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the enterprise to which you have switched.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The sales channel ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactOperationDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The message returned by the operation.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => [ + 'description' => 'The data result of the current category statistics.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'True'], + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'ErrorList' => [ + 'description' => 'The error status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The error status information.', + 'type' => 'object', + 'properties' => [ + 'Item' => [ + 'title' => '', + 'description' => 'The field with an exception.', + 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'], + 'type' => 'string', + 'example' => 'MOBILE_VERIFY_CODE', + ], + 'ErrorCode' => [ + 'title' => '', + 'description' => 'The error code.', + 'enumValueTitles' => ['EMAIL_CODE_ILLEGAL' => 'EMAIL_CODE_ILLEGAL', 'MOBILE_FORMAT_ILLEGAL' => 'MOBILE_FORMAT_ILLEGAL', 'NAME_ILLEGAL' => 'NAME_ILLEGAL', 'EMAIL_FORMAT_ILLEGAL' => 'EMAIL_FORMAT_ILLEGAL', 'POSITION_ILLEGAL' => 'POSITION_ILLEGAL', 'MOBILE_CODE_ILLEGAL' => 'MOBILE_CODE_ILLEGAL'], + 'type' => 'string', + 'example' => 'MOBILE_CODE_ILLEGAL', + ], + 'ErrorDesc' => ['description' => 'The cause of the issue.', 'type' => 'string', 'example' => 'MOBILE_CODE_ILLEGAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'ContactReachLimit', 'errorMessage' => 'The number of current account contacts has reached the upper limit.', 'description' => 'The number of current account contacts has reached the upper limit.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4E192DF-798B-58AE-B8BF-EBC15E2E85F2\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"ContactId\\": 0,\\n \\"ErrorList\\": [\\n {\\n \\"Item\\": \\"MOBILE_VERIFY_CODE\\",\\n \\"ErrorCode\\": \\"MOBILE_CODE_ILLEGAL\\",\\n \\"ErrorDesc\\": \\"MOBILE_CODE_ILLEGAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Create an account contact', + 'description' => 'Creates an account contact.', + 'requestParamsDescription' => '- OrientedLeId, OrientedEcId, and OrientedNbId are used in cross-enterprise management scenarios. These parameters are not required for account contact scenarios. Leave them empty.'."\n" + .'- This operation can only manage account contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AccountContactDelete' => [ + 'summary' => 'Delete a private contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the account contact to delete. You can call AccountContactQueryPageList to query account contact information by page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The enterprise currently switched to.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The marketplace ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8CCD6B37-98E7-5A68-B1F7-A900C9BFF45C', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Data' => ['description' => 'The result data.', 'type' => 'boolean', 'example' => '{\'count\': 1}', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8CCD6B37-98E7-5A68-B1F7-A900C9BFF45C\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Delete an account contact', + 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId are used for cross-enterprise management scenarios. These parameters are not involved in account contact scenarios and can be left empty.'."\n" + .'- This API operation can only manage account contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AccountContactEdit' => [ + 'summary' => 'Modify a private contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'Contact ID. You can call AccountContactQueryPageList to query account contact information by page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Contact name', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Contact email', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'], + ], + [ + 'name' => 'ContactMobile', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Contact mobile number', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'], + ], + [ + 'name' => 'ContactPosition', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'Position:', + 'enumValueTitles' => ['TECH_MANAGER Technical Manager', 'MAINTAIN_MANAGER O&M Manager', 'PROJECT_MANAGER Project Manager', 'FINANCE_MANAGER Finance Manager', 'CEO', 'OTHER Other'], + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'EmailCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Email verification code', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'MobileCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'SMS verification code', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Whether it is an enterprise contact. This API sets the value to false by default.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AsyncEmailVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Whether to asynchronously verify the email. Must be set to true for API calls. Otherwise, the verification code will be synchronously validated. Use the SendAsyncEmailCaptcha API to send the verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsyncMobileVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Whether to asynchronously verify the mobile number. Must be set to true for API calls. Otherwise, the verification code will be synchronously validated. Use the SendAsyncMobileCaptcha API to send the verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'."\n"], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'Application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Currently switched enterprise', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'Cross-enterprise management object entity ID', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'Cross-enterprise management object marketplace ID', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactOperationDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values: true: succeeded. false: failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'Data result of the current category statistics', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'Whether successful', 'type' => 'boolean', 'example' => '{\'TeamDesktops\': [], \'PrivateDesktops\': [], \'UnallocatedTeamDesktops\': []}'], + 'ContactId' => ['title' => '', 'description' => 'Contact ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'ErrorList' => [ + 'description' => 'Error codes.', + 'type' => 'array', + 'items' => [ + 'description' => 'Error information reported by the backup server.', + 'type' => 'object', + 'properties' => [ + 'Item' => [ + 'title' => '', + 'description' => 'Exception field', + 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'], + 'type' => 'string', + 'example' => 'MOBILE_VERIFY_CODE', + ], + 'ErrorCode' => [ + 'title' => '', + 'description' => 'Error code', + 'enumValueTitles' => ['EMAIL_CODE_ILLEGAL' => 'EMAIL_CODE_ILLEGAL', 'MOBILE_FORMAT_ILLEGAL' => 'MOBILE_FORMAT_ILLEGAL', 'NAME_ILLEGAL' => 'NAME_ILLEGAL', 'EMAIL_FORMAT_ILLEGAL' => 'EMAIL_FORMAT_ILLEGAL', 'POSITION_ILLEGAL' => 'POSITION_ILLEGAL', 'MOBILE_CODE_ILLEGAL' => 'MOBILE_CODE_ILLEGAL'], + 'type' => 'string', + 'example' => 'MOBILE_CODE_ILLEGAL', + ], + 'ErrorDesc' => ['description' => 'Cause of the diagnostic issue.', 'type' => 'string', 'example' => 'MOBILE_CODE_ILLEGAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E4E192DF-798B-58AE-B8BF-EBC15E2E85F2\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"ContactId\\": 0,\\n \\"ErrorList\\": [\\n {\\n \\"Item\\": \\"MOBILE_VERIFY_CODE\\",\\n \\"ErrorCode\\": \\"MOBILE_CODE_ILLEGAL\\",\\n \\"ErrorDesc\\": \\"MOBILE_CODE_ILLEGAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Modify account contact', + 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId are used for cross-enterprise management scenarios. These parameters are not involved in account contact scenarios and can be left empty.'."\n" + .'- API calls use the asynchronous verification process. Use the SendAsyncMobileCaptcha/SendAsyncEmailCaptcha APIs to send verification links for verification. You do not need to enter a verification code.'."\n" + .'- This API can only manage account contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactEdit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AccountContactQueryDetail' => [ + 'summary' => 'Queries the details of a contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'The contact ID. You can call the AccountContactQueryPageList operation to perform a paged query to retrieve contacts by paging.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'yanxuan', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The enterprise currently switched to.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The marketplace ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'DA632E90-32DB-52DE-823B-4A182169D954', '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' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Data' => [ + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'CustomerId' => ['title' => '', 'description' => 'The customer ID. This parameter is compatible with the legacy model.', 'type' => 'string', 'example' => 'xxx'], + 'EntityId' => ['title' => '', 'description' => 'The entity ID.', 'type' => 'string', 'example' => 'xxx'], + 'EntityType' => ['title' => '', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'], + 'ContactName' => ['title' => '', 'description' => 'The contact name.', 'type' => 'string', 'example' => 'xxx'], + 'ContactEmail' => ['title' => '', 'description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'xxx@xxx.xx'], + 'ContactMobile' => ['title' => '', 'description' => 'The mobile phone number of the contact.', 'type' => 'string', 'example' => '1xxxxxxxxxx'], + 'ContactPosition' => ['title' => '', 'description' => 'The position of the contact.', 'type' => 'string', 'example' => '4'], + 'EmailConfirmed' => ['title' => '', 'description' => 'Indicates whether the email address is verified.', 'type' => 'boolean', 'example' => 'true'], + 'MobileConfirmed' => ['title' => '', 'description' => 'Indicates whether the mobile phone number is verified.', 'type' => 'boolean', 'example' => 'true'], + 'SharedContact' => ['title' => '', 'description' => 'Indicates whether the contact is a shared contact.', 'type' => 'boolean', 'example' => 'false'], + 'UpdateUser' => ['title' => '', 'description' => 'The user who last modified the contact.', 'type' => 'string', 'example' => 'xxx'], + 'UpdateDate' => ['title' => '', 'description' => 'The time when the contact was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'HasSubscription' => ['title' => '', 'description' => 'Indicates whether the contact has subscriptions when querying contact details.', 'type' => 'boolean', 'example' => 'xxx'], + 'Uid' => ['title' => '', 'description' => 'The owner of the contact.', 'type' => 'string', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DA632E90-32DB-52DE-823B-4A182169D954\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": {\\n \\"ContactId\\": 0,\\n \\"CustomerId\\": \\"xxx\\",\\n \\"EntityId\\": \\"xxx\\",\\n \\"EntityType\\": \\"customerId\\",\\n \\"ContactName\\": \\"xxx\\",\\n \\"ContactEmail\\": \\"xxx@xxx.xx\\",\\n \\"ContactMobile\\": \\"1xxxxxxxxxx\\",\\n \\"ContactPosition\\": \\"4\\",\\n \\"EmailConfirmed\\": true,\\n \\"MobileConfirmed\\": true,\\n \\"SharedContact\\": false,\\n \\"UpdateUser\\": \\"xxx\\",\\n \\"UpdateDate\\": 0,\\n \\"HasSubscription\\": true,\\n \\"Uid\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query contact details', + 'requestParamsDescription' => 'OrientedLeId, OrientedEcId, and OrientedNbId are used in cross-enterprise management scenarios. These parameters are not required for account contact scenarios. Leave them empty.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactQueryDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'AccountContactQueryPageList' => [ + 'summary' => 'Queries the contact list.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name, email address, or mobile number used to filter contacts.', 'type' => 'string', 'required' => false, 'example' => 'keyword'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query only shared contacts. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the enterprise currently switched to.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'PrivateContact', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to query only private contacts of the account. Default value: true.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ShowCompleteInfo', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to display complete information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'ListResult<ContactDTO>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '19'], + 'PageNo' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'TotalPage' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '27A90A55-120A-59DC-812E-62448D440E95', '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' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The log content of the standard output during function execution.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => [ + 'description' => 'The operation result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'CustomerId' => ['title' => '', 'description' => 'The customer ID, compatible with the legacy model.', 'type' => 'string', 'example' => 'xxx'], + 'EntityId' => ['title' => '', 'description' => 'The entity ID.', 'type' => 'string', 'example' => 'xxx'], + 'EntityType' => ['title' => '', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'], + 'ContactName' => ['title' => '', 'description' => 'The contact name.', 'type' => 'string', 'example' => 'xxx'], + 'ContactEmail' => ['title' => '', 'description' => 'The email address of the contact.', 'type' => 'string', 'example' => 'xxx@xxx.xx'], + 'ContactMobile' => ['title' => '', 'description' => 'The mobile number of the contact.', 'type' => 'string', 'example' => '1xxxxxxxxxx'], + 'ContactPosition' => ['title' => '', 'description' => 'The position of the contact.', 'type' => 'string', 'example' => '1'], + 'EmailConfirmed' => ['title' => '', 'description' => 'Indicates whether the email address is verified.', 'type' => 'boolean', 'example' => 'true'], + 'MobileConfirmed' => ['title' => '', 'description' => 'Indicates whether the mobile number is verified.', 'type' => 'boolean', 'example' => 'true'], + 'SharedContact' => ['title' => '', 'description' => 'Indicates whether the contact is a shared contact.', 'type' => 'boolean', 'example' => 'false'], + 'UpdateUser' => ['title' => '', 'description' => 'The user who last modified the contact.', 'type' => 'string', 'example' => 'xxx'], + 'UpdateDate' => ['title' => '', 'description' => 'The time when the contact was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 4,\\n \\"PageSize\\": 19,\\n \\"PageNo\\": 3,\\n \\"TotalPage\\": 1,\\n \\"RequestId\\": \\"27A90A55-120A-59DC-812E-62448D440E95\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"ContactId\\": 0,\\n \\"CustomerId\\": \\"xxx\\",\\n \\"EntityId\\": \\"xxx\\",\\n \\"EntityType\\": \\"customerId\\",\\n \\"ContactName\\": \\"xxx\\",\\n \\"ContactEmail\\": \\"xxx@xxx.xx\\",\\n \\"ContactMobile\\": \\"1xxxxxxxxxx\\",\\n \\"ContactPosition\\": \\"1\\",\\n \\"EmailConfirmed\\": true,\\n \\"MobileConfirmed\\": true,\\n \\"SharedContact\\": false,\\n \\"UpdateUser\\": \\"xxx\\",\\n \\"UpdateDate\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query account contacts by page', + 'requestParamsDescription' => 'The OrientedLeId, OrientedEcId, and OrientedNbId parameters are used in cross-enterprise management scenarios. These parameters are not required for account contact scenarios and can be left empty.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AccountContactQueryPageList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactQueryPageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnterpriseContactAdd' => [ + 'summary' => 'Adds an enterprise contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email address of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'], + ], + [ + 'name' => 'ContactMobile', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The mobile phone number of the contact.', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'], + ], + [ + 'name' => 'ContactPosition', + 'in' => 'formData', + 'schema' => [ + 'title' => '', + 'description' => 'The position of the contact. Valid values:'."\n" + .'- TECH_MANAGER: technical manager.'."\n" + .'- MAINTAIN_MANAGER: O&M manager.'."\n" + .'- PROJECT_MANAGER: project manager.'."\n" + .'- FINANCE_MANAGER: finance manager.'."\n" + .'- OTHER: other.', + 'enumValueTitles' => ['TECH_MANAGER: technical manager.', 'MAINTAIN_MANAGER: O&M manager.', 'PROJECT_MANAGER: project manager.', 'FINANCE_MANAGER: finance manager.', 'CEO', 'OTHER: other.'], + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'EmailCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'MobileCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The SMS verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the contact is a public contact. This operation sets this parameter to true by default.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsyncEmailVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the email address. Set this parameter to true for API calls. Otherwise, the verification code is synchronously verified. Call the SendAsyncEmailCaptcha operation to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsyncMobileVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the mobile phone number. Set this parameter to true for API calls. Otherwise, the verification code is synchronously verified. Call the SendAsyncMobileCaptcha operation to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the enterprise to which you have switched.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The sales site ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactOperationDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '40EA3ECB-2167-5A8E-9327-F7E59E508FA8', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'OK'], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Successful!', 'title' => ''], + 'Data' => [ + 'description' => 'The data result of the current category statistics.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'xxx'], + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'ErrorList' => [ + 'description' => 'The error status information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The fault error message reported by the backup server.', + 'type' => 'object', + 'properties' => [ + 'Item' => [ + 'title' => '', + 'description' => 'The field that caused the exception.', + 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'], + 'type' => 'string', + 'example' => 'MOBILE_VERIFY_CODE', + ], + 'ErrorCode' => [ + 'title' => '', + 'description' => 'The error code.', + 'enumValueTitles' => ['EMAIL_CODE_ILLEGAL' => 'EMAIL_CODE_ILLEGAL', 'MOBILE_FORMAT_ILLEGAL' => 'MOBILE_FORMAT_ILLEGAL', 'NAME_ILLEGAL' => 'NAME_ILLEGAL', 'EMAIL_FORMAT_ILLEGAL' => 'EMAIL_FORMAT_ILLEGAL', 'POSITION_ILLEGAL' => 'POSITION_ILLEGAL', 'MOBILE_CODE_ILLEGAL' => 'MOBILE_CODE_ILLEGAL'], + 'type' => 'string', + 'example' => 'MOBILE_CODE_ILLEGAL', + ], + 'ErrorDesc' => ['description' => 'The description of the diagnosed issue.', 'type' => 'string', 'example' => 'Mobile Code Illegal', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ['errorCode' => 'ContactReachLimit', 'errorMessage' => 'The number of current account contacts has reached the upper limit.', 'description' => 'The number of current account contacts has reached the upper limit.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40EA3ECB-2167-5A8E-9327-F7E59E508FA8\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"Successful!\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"ContactId\\": 0,\\n \\"ErrorList\\": [\\n {\\n \\"Item\\": \\"MOBILE_VERIFY_CODE\\",\\n \\"ErrorCode\\": \\"MOBILE_CODE_ILLEGAL\\",\\n \\"ErrorDesc\\": \\"Mobile Code Illegal\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Create an enterprise contact', + 'description' => 'Creates an enterprise public contact.'."\n" + .'For information about Alibaba Cloud account authorization, refer to [documentation](https://www.alibabacloud.com/help/en/account/user-guide/add-business-address-and-business-contact).', + 'requestParamsDescription' => '- OrientedLeId, OrientedEcId, and OrientedNbId are used in cross-enterprise management scenarios. This feature is not yet available. Leave these parameters empty.'."\n" + .'- This operation uses an asynchronous verification process. Use the SendAsyncMobileCaptcha or SendAsyncEmailCaptcha operation to send a verification link for verification. You do not need to specify a verification code.'."\n" + .'- This operation can only manage enterprise contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnterpriseContactDelete' => [ + 'summary' => 'Deletes an enterprise contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the contact to delete. You can call EnterpriseQueryPageList to query contact information by paging.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The enterprise currently switched to.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The marketplace ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '36E0A548-4BA3-549B-8855-22E3F5C6D47E', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Data' => ['description' => 'The processing result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"36E0A548-4BA3-549B-8855-22E3F5C6D47E\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Delete an enterprise contact', + 'description' => 'Deletes an enterprise public contact. For information about Alibaba Cloud account authorization, refer to the [documentation](https://www.alibabacloud.com/help/en/account/user-guide/add-business-address-and-business-contact).', + 'requestParamsDescription' => '- OrientedLeId, OrientedEcId, and OrientedNbId are used for cross-enterprise management scenarios. This feature is not yet available. Leave these parameters empty.'."\n" + .'- This operation can only manage enterprise contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnterpriseContactEdit' => [ + 'summary' => 'Modifies a private enterprise contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the contact to modify. You can invoke the EnterpriseContactQueryPageList operation to perform a paged query of account contact information.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], + ], + [ + 'name' => 'ContactEmail', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email address of the contact.', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'], + ], + [ + 'name' => 'ContactMobile', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The mobile phone number of the contact.', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'], + ], + [ + 'name' => 'ContactPosition', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The position of the contact.', 'type' => 'string', 'required' => false, 'example' => '2'], + ], + [ + 'name' => 'EmailCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'MobileCode', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The SMS verification code.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the contact is a public contact. This operation sets this parameter to true by default.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsyncEmailVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the email address. Set this parameter to true for API calls. Otherwise, the verification code is synchronously and strictly verified. Call SendAsyncEmailCaptcha to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AsyncMobileVerify', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to asynchronously verify the mobile phone number. Set this parameter to true for API calls. Otherwise, the verification code is synchronously and strictly verified. Call SendAsyncMobileCaptcha to send a verification link.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the enterprise to which you have switched.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The sales channel ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactOperationDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '516C2364-18B7-5BAC-9288-AAEA85EEA351', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The result message of the call.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Data' => [ + 'description' => 'The data result of the current category statistics.', + 'type' => 'object', + 'properties' => [ + 'Result' => ['title' => '', 'description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true'], + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'ErrorList' => [ + 'description' => 'The error message reported by the backup server.', + 'type' => 'array', + 'items' => [ + 'description' => 'The error message reported by the backup server.', + 'type' => 'object', + 'properties' => [ + 'Item' => [ + 'title' => '', + 'description' => 'The field with an exception.', + 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'], + 'type' => 'string', + 'example' => 'MOBILE_VERIFY_CODE', + ], + 'ErrorCode' => [ + 'title' => '', + 'description' => 'The error code.', + 'enumValueTitles' => ['EMAIL_CODE_ILLEGAL' => 'EMAIL_CODE_ILLEGAL', 'MOBILE_FORMAT_ILLEGAL' => 'MOBILE_FORMAT_ILLEGAL', 'NAME_ILLEGAL' => 'NAME_ILLEGAL', 'EMAIL_FORMAT_ILLEGAL' => 'EMAIL_FORMAT_ILLEGAL', 'POSITION_ILLEGAL' => 'POSITION_ILLEGAL', 'MOBILE_CODE_ILLEGAL' => 'MOBILE_CODE_ILLEGAL'], + 'type' => 'string', + 'example' => 'MOBILE_CODE_ILLEGAL', + ], + 'ErrorDesc' => ['description' => 'The description of the diagnosed issue.', 'type' => 'string', 'example' => 'Mobile Code Illegal', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"516C2364-18B7-5BAC-9288-AAEA85EEA351\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SUCCESS\\",\\n \\"Data\\": {\\n \\"Result\\": true,\\n \\"ContactId\\": 0,\\n \\"ErrorList\\": [\\n {\\n \\"Item\\": \\"MOBILE_VERIFY_CODE\\",\\n \\"ErrorCode\\": \\"MOBILE_CODE_ILLEGAL\\",\\n \\"ErrorDesc\\": \\"Mobile Code Illegal\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Modify an enterprise contact', + 'description' => 'Modifies a public enterprise contact. For information about primary account authorization, see [documentation](https://www.alibabacloud.com/help/en/account/user-guide/add-business-address-and-business-contact).', + 'requestParamsDescription' => '- OrientedLeId, OrientedEcId, and OrientedNbId are used in cross-enterprise management scenarios. This feature is not yet available. Leave these parameters empty.'."\n" + .'- This operation uses an asynchronous verification process. Use SendAsyncMobileCaptcha or SendAsyncEmailCaptcha to send a verification link for verification. You do not need to enter a verification code.'."\n" + .'- This operation can only manage enterprise contacts.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactEdit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnterpriseContactQueryDetail' => [ + 'summary' => 'Queries the details of a contact.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The enterprise currently switched to.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The marketplace ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<ContactDTO>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F81F2090-8260-5052-BB93-7DF8996D25EB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'Success'], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => [ + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xx'], + 'CustomerId' => ['title' => '', 'description' => 'The customer ID, compatible with the legacy model.', 'type' => 'string', 'example' => 'xxx'], + 'EntityId' => ['title' => '', 'description' => 'The entity ID.', 'type' => 'string', 'example' => '3489d3bc-077a-449b-b41e-dd81f7451a42'], + 'EntityType' => ['title' => '', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'], + 'ContactName' => ['title' => '', 'description' => 'The contact name.', 'type' => 'string', 'example' => 'xxx'], + 'ContactEmail' => ['title' => '', 'description' => 'The contact email address.', 'type' => 'string', 'example' => 'xx@xx.xx'], + 'ContactMobile' => ['title' => '', 'description' => 'The contact mobile number.', 'type' => 'string', 'example' => '1xxxxxxxxxx'], + 'ContactPosition' => ['title' => '', 'description' => 'The position of the contact.', 'type' => 'string', 'example' => '4'], + 'EmailConfirmed' => ['title' => '', 'description' => 'Indicates whether the email address is verified.', 'type' => 'boolean', 'example' => 'false'], + 'MobileConfirmed' => ['title' => '', 'description' => 'Indicates whether the mobile number is verified.', 'type' => 'boolean', 'example' => 'false'], + 'SharedContact' => ['title' => '', 'description' => 'Indicates whether the contact is a shared contact.', 'type' => 'boolean', 'example' => 'false'], + 'UpdateUser' => ['title' => '', 'description' => 'The user who last modified the contact.', 'type' => 'string', 'example' => 'xxx'], + 'UpdateDate' => ['title' => '', 'description' => 'The time when the contact was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'HasSubscription' => ['title' => '', 'description' => 'Indicates whether the contact has subscribed to projects when querying contact details.', 'type' => 'boolean', 'example' => 'xxx'], + 'Uid' => ['title' => '', 'description' => 'The owner of the contact.', 'type' => 'string', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F81F2090-8260-5052-BB93-7DF8996D25EB\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ContactId\\": 0,\\n \\"CustomerId\\": \\"xxx\\",\\n \\"EntityId\\": \\"3489d3bc-077a-449b-b41e-dd81f7451a42\\",\\n \\"EntityType\\": \\"customerId\\",\\n \\"ContactName\\": \\"xxx\\",\\n \\"ContactEmail\\": \\"xx@xx.xx\\",\\n \\"ContactMobile\\": \\"1xxxxxxxxxx\\",\\n \\"ContactPosition\\": \\"4\\",\\n \\"EmailConfirmed\\": false,\\n \\"MobileConfirmed\\": false,\\n \\"SharedContact\\": false,\\n \\"UpdateUser\\": \\"xxx\\",\\n \\"UpdateDate\\": 0,\\n \\"HasSubscription\\": true,\\n \\"Uid\\": \\"xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query enterprise contact details', + 'description' => 'Queries the details of a single enterprise contact.', + 'requestParamsDescription' => 'OrientedLeId, OrientedEcId, and OrientedNbId are used for cross-enterprise management scenarios. This feature is not yet available. Leave these parameters empty.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactQueryDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnterpriseContactQueryPageList' => [ + 'summary' => 'Query the contact list.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Page number, default 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Page size, default 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'Query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Name, email, or mobile number.', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'], + ], + [ + 'name' => 'SharedContact', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Whether it is a shared contact. The default value of this parameter is set to true for this API.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The client application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'OrientedLeId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The currently switched enterprise.', 'type' => 'string', 'required' => false, 'example' => 'null'], + ], + [ + 'name' => 'OrientedEcId', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'OrientedNbId', + 'in' => 'formData', + 'schema' => ['description' => 'The marketplace ID of the cross-enterprise management object.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'PrivateContact', + 'in' => 'formData', + 'schema' => ['description' => 'The flag for querying private contacts. The default value of this parameter is set to false for this API.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ShowCompleteInfo', + 'in' => 'query', + 'schema' => ['description' => 'Whether to display complete information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'ListResult<ContactDTO>', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['title' => '', 'description' => 'Total data count.', 'type' => 'integer', 'format' => 'int32', 'example' => '11'], + 'PageSize' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageNo' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalPage' => ['title' => '', 'description' => 'Total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'C0A6196F-52A0-5EC9-B8D3-263CEF806EC4', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'Data' => [ + 'description' => 'The operation result.', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation result.', + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + 'CustomerId' => ['title' => '', 'description' => 'The customer ID, compatible with the old model.', 'type' => 'string', 'example' => 'xxx'], + 'EntityId' => ['title' => '', 'description' => 'The entity ID.', 'type' => 'string', 'example' => 'xxx'], + 'EntityType' => ['title' => '', 'description' => 'The entity type. Valid values: leId and customerId.', 'type' => 'string', 'example' => 'customerId'], + 'ContactName' => ['title' => '', 'description' => 'The contact name.', 'type' => 'string', 'example' => '曾老师'], + 'ContactEmail' => ['title' => '', 'description' => 'The contact email.', 'type' => 'string', 'example' => 'xx@xx.xx'], + 'ContactMobile' => ['title' => '', 'description' => 'The contact mobile number.', 'type' => 'string', 'example' => '1xxxxxxxxxx'], + 'ContactPosition' => ['title' => '', 'description' => 'The position.', 'type' => 'string', 'example' => '1'], + 'EmailConfirmed' => ['title' => '', 'description' => 'Whether the email is verified.', 'type' => 'boolean', 'example' => 'true'], + 'MobileConfirmed' => ['title' => '', 'description' => 'Whether the mobile number is verified.', 'type' => 'boolean', 'example' => 'true'], + 'SharedContact' => ['title' => '', 'description' => 'Whether it is a shared contact.', 'type' => 'boolean', 'example' => 'false'], + 'UpdateUser' => ['title' => '', 'description' => 'The user who last modified the contact.', 'type' => 'string', 'example' => 'xx'], + 'UpdateDate' => ['title' => '', 'description' => 'The time when the contact was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 11,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": 1,\\n \\"TotalPage\\": 0,\\n \\"RequestId\\": \\"C0A6196F-52A0-5EC9-B8D3-263CEF806EC4\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"ContactId\\": 0,\\n \\"CustomerId\\": \\"xxx\\",\\n \\"EntityId\\": \\"xxx\\",\\n \\"EntityType\\": \\"customerId\\",\\n \\"ContactName\\": \\"曾老师\\",\\n \\"ContactEmail\\": \\"xx@xx.xx\\",\\n \\"ContactMobile\\": \\"1xxxxxxxxxx\\",\\n \\"ContactPosition\\": \\"1\\",\\n \\"EmailConfirmed\\": true,\\n \\"MobileConfirmed\\": true,\\n \\"SharedContact\\": false,\\n \\"UpdateUser\\": \\"xx\\",\\n \\"UpdateDate\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query enterprise contacts by page', + 'description' => 'Query enterprise contacts by page.', + 'requestParamsDescription' => 'OrientedLeId, OrientedEcId, and OrientedNbId are used for cross-enterprise management scenarios. This feature is not yet available. You can leave the related parameters empty.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnterpriseContactQueryPageList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactQueryPageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SendAsyncEmailCaptcha' => [ + 'summary' => 'Sends an asynchronous email verification message to verify the email address of a specified contact.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ContactInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The contact information.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'ContactorId', + 'in' => 'formData', + 'schema' => ['description' => 'The contact ID.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '5E9636D3-6C10-5FAB-B391-EDD122E28BC6', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'Instance invalid-id-123 does not exist.', 'title' => ''], + 'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'VerifyCodeSendTimesOverLimited', 'errorMessage' => 'Verify Code Send Times Over Limited.', 'description' => 'The number of verification code sent exceeds the frequency limit, please try again later.'], + ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ['errorCode' => 'AsyncVerifyContactNotFound', 'errorMessage' => 'Contact does not exist or has been deleted.', 'description' => 'The contact does not exist or has been deleted.'], + ['errorCode' => 'AsyncVerifyEmailMismatch', 'errorMessage' => 'The request mailbox is not consistent with the contact mailbox.', 'description' => 'The request mailbox is not consistent with the contact mailbox.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E9636D3-6C10-5FAB-B391-EDD122E28BC6\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"Instance invalid-id-123 does not exist.\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Send asynchronous email verification message', + 'description' => 'Sends an asynchronous verification link for a contact\'s email address. Additional rate limits apply. The same account and contact information combination cannot exceed 20 requests within 5 minutes. The same account cannot exceed 300 requests globally within 24 hours.', + 'requestParamsDescription' => 'The contact ID must be within the range of contacts manageable by the current requesting account. Refer to the [personal address contact documentation](https://www.alibabacloud.com/help/en/account/add-personal-addresses-and-personal-contacts) and the [enterprise address contact documentation](https://www.alibabacloud.com/help/en/account/user-guide/add-business-address-and-business-contact).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:SendAsyncEmailCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'SendAsyncMobileCaptcha' => [ + 'summary' => 'Sends an asynchronous verification SMS to a phone number to verify the phone number of a specified contact.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ContactInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The contact information.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'ContactorId', + 'in' => 'formData', + 'schema' => ['description' => 'The contact ID.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'formData', + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Result<Boolean>', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1409E8EE-8F9A-506B-BACB-B9DF3634C287', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The operation result.', 'type' => 'boolean', 'example' => 'False', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + ['errorCode' => 'VerifyCodeSendTimesOverLimited', 'errorMessage' => 'Verify Code Send Times Over Limited.', 'description' => 'The number of verification code sent exceeds the frequency limit, please try again later.'], + ['errorCode' => 'AsyncVerifyContactNotFound', 'errorMessage' => 'Contact does not exist or has been deleted.', 'description' => 'The contact does not exist or has been deleted.'], + ['errorCode' => 'AsyncVerifyMobileMismatch', 'errorMessage' => 'The request phone number is inconsistent with the contact phone number.', 'description' => 'The request phone number is inconsistent with the contact phone number.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1409E8EE-8F9A-506B-BACB-B9DF3634C287\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'Send asynchronous phone number verification SMS', + 'description' => 'Sends an asynchronous verification link for a contact\'s contact information. Additional rate limits apply. The same account and contact information combination cannot exceed 20 requests within 5 minutes. The same account cannot exceed 300 requests globally within 24 hours.', + 'requestParamsDescription' => 'The contact ID must be within the range of contacts manageable by the current requesting account. Refer to the [personal address contact documentation](https://www.alibabacloud.com/help/en/account/add-personal-addresses-and-personal-contacts) and the [enterprise address contact documentation](https://www.alibabacloud.com/help/en/account/user-guide/add-business-address-and-business-contact).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:SendAsyncMobileCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + ], + 'endpoints' => [ + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'accountcenter-intl.aliyuncs.com', 'endpoint' => 'accountcenter-intl.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'accountcenter.cn-hangzhou.aliyuncs.com', 'endpoint' => 'accountcenter.cn-hangzhou.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'AsyncVerifyContactNotFound', 'message' => 'Contact does not exist or has been deleted.', 'http_code' => 200, 'description' => 'The contact does not exist or has been deleted.'], + ['code' => 'AsyncVerifyEmailMismatch', 'message' => 'The request mailbox is not consistent with the contact mailbox.', 'http_code' => 200, 'description' => 'The request mailbox is not consistent with the contact mailbox.'], + ['code' => 'AsyncVerifyMobileMismatch', 'message' => 'The request phone number is inconsistent with the contact phone number.', 'http_code' => 200, 'description' => 'The request phone number is inconsistent with the contact phone number.'], + ['code' => 'ContactReachLimit', 'message' => 'The number of current account contacts has reached the upper limit.', 'http_code' => 200, 'description' => 'The number of current account contacts has reached the upper limit.'], + ['code' => 'EmailConflict', 'message' => 'Email is duplicated.', 'http_code' => 200, 'description' => 'Login mailbox conflict, corresponding Aliyun account already exists'], + ['code' => 'LoginIdInBlackList', 'message' => 'Login ID is in black list.', 'http_code' => 200, 'description' => 'The login name corresponding to the current mailbox is in the blacklist, please change a mailbox'], + ['code' => 'NoPermission', 'message' => 'No permission.', 'http_code' => 200, 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ['code' => 'NO_PERMISSION', 'message' => 'No permission.', 'http_code' => 200, 'description' => 'No permissions. Please check whether your enterprise multi-account permissions and relevant access policies are granted. Check whether the requested resource has permission management.'], + ['code' => 'PasswordIsSameAsLast', 'message' => 'password can\'t be the same with last password.', 'http_code' => 200, 'description' => 'The modified password cannot be the same as the current password'], + ['code' => 'PasswordIsSameAsPrevious3OldPassword', 'message' => 'password can\'t be the same with previous 3 times password.', 'http_code' => 200, 'description' => 'The newly entered password cannot be the same as the password used three times in the past.'], + ['code' => 'VerifyCodeSendTimesOverLimited', 'message' => 'Verify Code Send Times Over Limited.', 'http_code' => 200, 'description' => 'The number of verification code sent exceeds the frequency limit, please try again later.'], + ['code' => 'VERIFY_CODE_SEND_TIMES_OVER_LIMITED', 'message' => 'VERIFY CODE SEND TIMES OVER LIMITED.', 'http_code' => 200, 'description' => 'The number of verification code sent exceeds the frequency limit, please try again later.'], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AccountContactQueryPageList'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnterpriseContactQueryPageList'], + ], + ], + 'ram' => [ + 'productCode' => 'AccountCenter', + 'productName' => 'account_center', + 'ramCodes' => ['accountcenter'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'AccountContactDelete', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendAsyncMobileCaptcha', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:SendAsyncMobileCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SendAsyncEmailCaptcha', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:SendAsyncEmailCaptcha', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnterpriseContactDelete', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AccountContactAdd', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnterpriseContactEdit', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactEdit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnterpriseContactQueryDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactQueryDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnterpriseContactQueryPageList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactQueryPageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AccountContactQueryPageList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactQueryPageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AccountContactEdit', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactEdit', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'EnterpriseContactAdd', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'accountcenter:EnterpriseContactAdd', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AccountContactQueryDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'accountcenter:AccountContactQueryDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [], + ], ]; |