summaryrefslogtreecommitdiff
path: root/data/zh_cn/accountcenter/2024-12-09/api-docs.php
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/accountcenter/2024-12-09/api-docs.php
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/accountcenter/2024-12-09/api-docs.php')
-rw-r--r--data/zh_cn/accountcenter/2024-12-09/api-docs.php2960
1 files changed, 966 insertions, 1994 deletions
diff --git a/data/zh_cn/accountcenter/2024-12-09/api-docs.php b/data/zh_cn/accountcenter/2024-12-09/api-docs.php
index d8cfaba..b8ce23b 100644
--- a/data/zh_cn/accountcenter/2024-12-09/api-docs.php
+++ b/data/zh_cn/accountcenter/2024-12-09/api-docs.php
@@ -1,57 +1,37 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'AccountCenter',
- 'version' => '2024-12-09',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'AccountCenter', 'version' => '2024-12-09'],
'directories' => [
[
- 'id' => 361645,
- 'title' => '联系人管理',
- 'type' => 'directory',
'children' => [
'SendAsyncMobileCaptcha',
'SendAsyncEmailCaptcha',
[
- 'id' => 361648,
- 'title' => '企业联系人管理',
+ 'children' => ['EnterpriseContactQueryPageList', 'EnterpriseContactQueryDetail', 'EnterpriseContactEdit', 'EnterpriseContactDelete', 'EnterpriseContactAdd'],
'type' => 'directory',
- 'children' => [
- 'EnterpriseContactQueryPageList',
- 'EnterpriseContactQueryDetail',
- 'EnterpriseContactEdit',
- 'EnterpriseContactDelete',
- 'EnterpriseContactAdd',
- ],
+ 'title' => '企业联系人管理',
+ 'id' => 433448,
],
[
- 'id' => 361654,
- 'title' => '账号联系人管理',
+ 'children' => ['AccountContactQueryPageList', 'AccountContactQueryDetail', 'AccountContactEdit', 'AccountContactDelete', 'AccountContactAdd'],
'type' => 'directory',
- 'children' => [
- 'AccountContactQueryPageList',
- 'AccountContactQueryDetail',
- 'AccountContactEdit',
- 'AccountContactDelete',
- 'AccountContactAdd',
- ],
+ 'title' => '账号联系人管理',
+ 'id' => 433454,
],
],
+ 'type' => 'directory',
+ 'title' => '联系人管理',
+ 'id' => 433445,
],
],
'components' => [
'schemas' => [],
],
'apis' => [
- 'SendAsyncMobileCaptcha' => [
- 'summary' => '发送手机号异步校验短信，用于验证指定联系人的手机号。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AccountContactAdd' => [
+ 'summary' => '创建账号联系人。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -59,490 +39,121 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'ContactInfo',
+ 'name' => 'ContactName',
'in' => 'formData',
- 'schema' => [
- 'description' => '联系方式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'ContactorId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '联系人id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'AppName',
+ 'name' => 'ContactEmail',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xxx'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求的唯一标识符。',
- 'type' => 'string',
- 'example' => '1409E8EE-8F9A-506B-BACB-B9DF3634C287',
- ],
- 'Success' => [
- 'description' => '请求成功与否标识。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '消息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'description' => '操作结果',
- 'type' => 'boolean',
- 'example' => 'False',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'VerifyCodeSendTimesOverLimited',
- 'errorMessage' => 'Verify Code Send Times Over Limited.',
- ],
- [
- 'errorCode' => 'AsyncVerifyContactNotFound',
- 'errorMessage' => 'Contact does not exist or has been deleted.',
- ],
- [
- 'errorCode' => 'AsyncVerifyMobileMismatch',
- 'errorMessage' => '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' => '发送手机号异步校验短信',
- 'description' => '发送联系人联系方式的异步验证链接。 存在额外流控。5分钟內同一账号+联系方式不超过20次。24小时內同一账号全局不超过300次。',
- 'requestParamsDescription' => '联系人id需要在当前请求账号可管理的联系人范围内。参考[地址联系人文档](https://help.aliyun.com/zh/account/add-personal-addresses-and-personal-contacts?spm=a2c4g.11186623.help-menu-35469.d_2_4.307a1738vMufL7&scm=20140722.H_2618535._.OR_help-T_cn~zh-V_1)以及[企业地址联系人文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.a5ca1738qFvysM&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)。',
- ],
- 'SendAsyncEmailCaptcha' => [
- 'summary' => '发送邮箱异步校验邮件，用于验证指定联系人的邮箱。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'ContactInfo',
+ 'name' => 'ContactMobile',
'in' => 'formData',
- 'schema' => [
- 'description' => '联系方式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'],
],
[
- 'name' => 'ContactorId',
+ 'name' => 'ContactPosition',
'in' => 'formData',
'schema' => [
- 'description' => '联系人id',
+ 'title' => '职位：',
+ 'description' => '职位：',
'type' => 'string',
'required' => false,
- 'example' => 'xxx',
+ 'enumValueTitles' => ['TECH_MANAGER技术负责人', 'MAINTAIN_MANAGER运维负责人', 'PROJECT_MANAGER项目负责人', 'FINANCE_MANAGER财务负责人', 'CEO', 'OTHER其它'],
+ 'example' => '0',
],
],
[
- 'name' => 'AppName',
+ 'name' => 'EmailCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '邮箱验证码', 'description' => '邮箱验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
- 'type' => 'object',
- 'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '5E9636D3-6C10-5FAB-B391-EDD122E28BC6',
- ],
- 'Success' => [
- 'description' => '请求成功与否标识。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '消息。',
- 'type' => 'string',
- 'example' => 'Instance invalid-id-123 does not exist.',
- ],
- 'Data' => [
- 'description' => '操作结果',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'VerifyCodeSendTimesOverLimited',
- 'errorMessage' => 'Verify Code Send Times Over Limited.',
- ],
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
- ],
- [
- 'errorCode' => 'AsyncVerifyContactNotFound',
- 'errorMessage' => 'Contact does not exist or has been deleted.',
- ],
- [
- 'errorCode' => 'AsyncVerifyEmailMismatch',
- 'errorMessage' => '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' => '发送邮箱异步校验邮件',
- 'description' => '发送联系人联系方式的异步验证链接。 存在额外流控。5分钟內同一账号+联系方式不超过20次。24小时內同一账号全局不超过300次。',
- 'requestParamsDescription' => '联系人id需要在当前请求账号可管理的联系人范围内。参考[地址联系人文档](https://help.aliyun.com/zh/account/add-personal-addresses-and-personal-contacts?spm=a2c4g.11186623.help-menu-35469.d_2_4.307a1738vMufL7&scm=20140722.H_2618535._.OR_help-T_cn~zh-V_1)以及[企业地址联系人文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.a5ca1738qFvysM&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)。',
- ],
- 'EnterpriseContactQueryPageList' => [
- 'summary' => '查询联系人列表。',
- 'methods' => [
- 'get',
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [
- [
- 'name' => 'PageNo',
+ 'name' => 'MobileCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '页码 default 1',
- 'description' => '页码 default 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '短信验证码', 'description' => '短信验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SharedContact',
'in' => 'formData',
- 'schema' => [
- 'title' => '页大小, default 10',
- 'description' => '页大小, default 10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否公共联系人。当前接口默认set false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
- 'name' => 'Query',
+ 'name' => 'AsyncEmailVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '姓名、邮箱、手机号',
- 'description' => '姓名、邮箱、手机号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false],
],
[
- 'name' => 'SharedContact',
+ 'name' => 'AsyncMobileVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人。当前接口默认set true。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '客户端应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- ],
- [
- 'name' => 'PrivateContact',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '私有联系人查询标志位。当前接口默认set false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
- ],
- [
- 'name' => 'ShowCompleteInfo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否进行数据脱敏',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'ListResult<ContactDTO>',
- 'description' => 'ListResult<ContactDTO>',
+ 'title' => 'Result<ContactOperationDTO>',
+ 'description' => 'Result<ContactOperationDTO>',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => '总数据量',
- 'description' => '总数据量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '11',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TotalPage' => [
- 'title' => '总页码数',
- 'description' => '总页码数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'C0A6196F-52A0-5EC9-B8D3-263CEF806EC4',
- ],
- 'Success' => [
- 'description' => '操作是否成功。取值：true：成功。false：失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => 'msg',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2'],
+ 'Success' => ['description' => '操作是否成功。取值：true：成功。false：失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '接口返回信息', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '操作结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '操作结果',
- 'type' => 'object',
- 'properties' => [
- 'ContactId' => [
- 'title' => '联系人ID',
- 'description' => '联系人ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'CustomerId' => [
- 'title' => '客户ID，兼容旧模型',
- 'description' => '客户ID，兼容旧模型',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityId' => [
- 'title' => '实体ID',
- 'description' => '实体ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityType' => [
- 'title' => 'leId/customerId',
- 'description' => 'leId/customerId',
- 'type' => 'string',
- 'example' => 'customerId',
- ],
- 'ContactName' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'example' => '曾老师',
- ],
- 'ContactEmail' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'example' => 'xx@xx.xx',
- ],
- 'ContactMobile' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'example' => '1xxxxxxxxxx',
- ],
- 'ContactPosition' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'EmailConfirmed' => [
- 'title' => '邮箱已验证',
- 'description' => '邮箱已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MobileConfirmed' => [
- 'title' => '手机号已验证',
- 'description' => '手机号已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SharedContact' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UpdateUser' => [
- 'title' => '最后修改人',
- 'description' => '最后修改人',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'UpdateDate' => [
- 'title' => '最后修改时间',
- 'description' => '最后修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
+ 'description' => '当前分类统计的数据结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Result' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'True'],
+ 'ContactId' => ['title' => '联系人Id', 'description' => '联系人Id', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'ErrorList' => [
+ 'description' => '错误状态信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '错误状态信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Item' => [
+ 'title' => 'NAME, EMAIL, MOBILE, POSITION, EMAIL_VERIFY_CODE, MOBILE_VERIFY_CODE',
+ 'description' => '异常字段',
+ 'type' => 'string',
+ 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'],
+ 'example' => 'MOBILE_VERIFY_CODE',
+ ],
+ 'ErrorCode' => [
+ 'title' => 'NAME_ILLEGAL, EMAIL_FORMAT_ILLEGAL, MOBILE_FORMAT_ILLEGAL, MOBILE_CODE_ILLEGAL, EMAIL_CODE_ILLEGAL, POSITION_ILLEGAL',
+ 'description' => '错误码',
+ 'type' => 'string',
+ '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'],
+ 'example' => 'MOBILE_CODE_ILLEGAL',
+ ],
+ 'ErrorDesc' => ['description' => '诊断问题的原因。', 'type' => 'string', 'example' => 'MOBILE_CODE_ILLEGAL'],
+ ],
],
],
],
@@ -553,244 +164,113 @@
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
+ ['errorCode' => 'ContactReachLimit', 'errorMessage' => 'The number of current account contacts has reached the upper limit.', 'description' => '当前账号联系人数量已达上限。'],
+ ],
+ ],
+ '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' => '创建账号联系人',
+ 'description' => '创建账号联系人',
+ 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
+ .'- 当前接口仅能管理账号联系人。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactAdd',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '分页查询企业联系人',
- 'description' => '分页查询企业联系人。',
- 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。',
],
- 'EnterpriseContactQueryDetail' => [
- 'summary' => '查询联系人详情。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AccountContactDelete' => [
+ 'summary' => '删除私有联系人。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '联系人ID。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '需要删除的账号联系人的ID。可调用AccountContactQueryPageList分页查询账号联系人信息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<ContactDTO>',
- 'description' => 'Result<ContactDTO>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'F81F2090-8260-5052-BB93-7DF8996D25EB',
- ],
- 'Success' => [
- 'description' => '操作是否成功。true表示成功，false表示失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Message' => [
- 'description' => '消息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '操作结果',
- 'type' => 'object',
- 'properties' => [
- 'ContactId' => [
- 'title' => '联系人ID',
- 'description' => '联系人ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xx',
- ],
- 'CustomerId' => [
- 'title' => '客户ID，兼容旧模型',
- 'description' => '客户ID，兼容旧模型',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityId' => [
- 'title' => '实体ID',
- 'description' => '实体ID',
- 'type' => 'string',
- 'example' => '3489d3bc-077a-449b-b41e-dd81f7451a42',
- ],
- 'EntityType' => [
- 'title' => 'leId/customerId',
- 'description' => 'leId/customerId',
- 'type' => 'string',
- 'example' => 'customerId',
- ],
- 'ContactName' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ContactEmail' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'example' => 'xx@xx.xx',
- ],
- 'ContactMobile' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'example' => '1xxxxxxxxxx',
- ],
- 'ContactPosition' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'EmailConfirmed' => [
- 'title' => '邮箱已验证',
- 'description' => '邮箱已验证',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MobileConfirmed' => [
- 'title' => '手机号已验证',
- 'description' => '手机号已验证',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'SharedContact' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UpdateUser' => [
- 'title' => '最后修改人',
- 'description' => '最后修改人',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'UpdateDate' => [
- 'title' => '最后修改时间',
- 'description' => '最后修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'HasSubscription' => [
- 'title' => '查询联系人详情时是否订阅项目',
- 'description' => '查询联系人详情时是否订阅项目',
- 'type' => 'boolean',
- 'example' => 'xxx',
- ],
- 'Uid' => [
- 'title' => '联系人归属人',
- 'description' => '联系人归属人',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '8CCD6B37-98E7-5A68-B1F7-A900C9BFF45C'],
+ 'Success' => ['description' => '操作是否成功。true表示成功，false表示失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'Successful!'],
+ 'Data' => ['description' => '结果数组', 'type' => 'boolean', 'example' => '{\'count\': 1}'],
],
],
],
],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
+ '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' => '删除账号联系人',
+ 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
+ .'- 当前接口仅能管理账号联系人。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactDelete',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '查询企业联系人详情',
- 'description' => '查询单个企业联系人详情。',
- 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。',
],
- 'EnterpriseContactEdit' => [
- 'summary' => '修改私企业联系人。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AccountContactEdit' => [
+ 'summary' => '修改私有联系人。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -798,56 +278,27 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '需要修改的联系人的ID。可调用EnterpriseContactQueryPageList分页查询账号联系人信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '联系人ID。可调用AccountContactQueryPageList分页查询账号联系人信息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ContactName',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ContactEmail',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx@xxx.xx',
- ],
+ 'schema' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'],
],
[
'name' => 'ContactMobile',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'],
],
[
'name' => 'ContactPosition',
@@ -857,105 +308,54 @@
'description' => '职位：',
'type' => 'string',
'required' => false,
- 'example' => '2',
+ 'enumValueTitles' => ['TECH_MANAGER技术负责人', 'MAINTAIN_MANAGER运维负责人', 'PROJECT_MANAGER项目负责人', 'FINANCE_MANAGER财务负责人', 'CEO', 'OTHER其它'],
+ 'example' => '0',
],
],
[
'name' => 'EmailCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '邮箱验证码',
- 'description' => '邮箱验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '邮箱验证码', 'description' => '邮箱验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'MobileCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '短信验证码',
- 'description' => '短信验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '短信验证码', 'description' => '短信验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'SharedContact',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人。当前接口默认set true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否企业联系人。当前接口默认set false。', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
],
[
'name' => 'AsyncEmailVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AsyncMobileVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'."\n"],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
@@ -965,46 +365,18 @@
'description' => 'Result<ContactOperationDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '516C2364-18B7-5BAC-9288-AAEA85EEA351',
- ],
- 'Success' => [
- 'description' => '操作是否成功。true表示成功，false表示失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '调用结果信息',
- 'type' => 'string',
- 'example' => 'SUCCESS',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2'],
+ 'Success' => ['description' => '操作是否成功。取值：true：成功。false：失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
'Data' => [
'description' => '当前分类统计的数据结果',
'type' => 'object',
'properties' => [
- 'Result' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ContactId' => [
- 'title' => '联系人Id',
- 'description' => '联系人Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
+ 'Result' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => '{\'TeamDesktops\': [], \'PrivateDesktops\': [], \'UnallocatedTeamDesktops\': []}'],
+ 'ContactId' => ['title' => '联系人Id', 'description' => '联系人Id', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
'ErrorList' => [
- 'description' => '备份服务器上报的错误信息。',
+ 'description' => '错误码。',
'type' => 'array',
'items' => [
'description' => '备份服务器上报的错误信息。',
@@ -1014,35 +386,17 @@
'title' => 'NAME, EMAIL, MOBILE, POSITION, EMAIL_VERIFY_CODE, MOBILE_VERIFY_CODE',
'description' => '异常字段',
'type' => 'string',
- 'enumValueTitles' => [
- 'POSITION' => 'POSITION',
- 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE',
- 'EMAIL' => 'EMAIL',
- 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE',
- 'NAME' => 'NAME',
- 'MOBILE' => 'MOBILE',
- ],
+ 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'],
'example' => 'MOBILE_VERIFY_CODE',
],
'ErrorCode' => [
'title' => 'NAME_ILLEGAL, EMAIL_FORMAT_ILLEGAL, MOBILE_FORMAT_ILLEGAL, MOBILE_CODE_ILLEGAL, EMAIL_CODE_ILLEGAL, POSITION_ILLEGAL',
'description' => '错误码',
'type' => 'string',
- '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',
- ],
+ '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'],
'example' => 'MOBILE_CODE_ILLEGAL',
],
- 'ErrorDesc' => [
- 'description' => '诊断问题的描述。',
- 'type' => 'string',
- 'example' => 'Mobile Code Illegal',
- ],
+ 'ErrorDesc' => ['description' => '诊断问题的原因。', 'type' => 'string', 'example' => 'MOBILE_CODE_ILLEGAL'],
],
],
],
@@ -1052,157 +406,258 @@
],
],
],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
+ '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' => '修改账号联系人',
+ 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
+ .'- 接口调用走异步验证流程，配合接口SendAsyncMobileCaptcha/SendAsyncEmailCaptcha发送验证链接进行验证。不需要填写验证码。'."\n"
+ .'- 当前接口仅能管理账号联系人。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactEdit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '修改企业联系人',
- 'description' => '修改企业公共联系人。主账号授权请参考[文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.744a1303wP4uCE&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)',
- 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。'."\n"
- .'- 接口调用走异步验证流程，配合接口SendAsyncMobileCaptcha/SendAsyncEmailCaptcha发送验证链接进行验证。不需要填写验证码。'."\n"
- .'- 当前接口仅能管理企业联系人。',
],
- 'EnterpriseContactDelete' => [
- 'summary' => '删除企业联系人。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AccountContactQueryDetail' => [
+ 'summary' => '查询联系人详情。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '需要删除的联系人的ID。可调用EnterpriseQueryPageList分页查询账号联系人信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '联系人ID。可以通过接口AccountContactQueryPageList分页查询', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'yanxuan'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
+ 'title' => 'Result<ContactDTO>',
+ 'description' => 'Result<ContactDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'DA632E90-32DB-52DE-823B-4A182169D954'],
+ 'Success' => ['description' => '表示是否调用成功。true：调用成功。 false：调用失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Successful!'],
+ 'Data' => [
+ 'description' => '操作结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['title' => '联系人ID', 'description' => '联系人ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'CustomerId' => ['title' => '客户ID，兼容旧模型', 'description' => '客户ID，兼容旧模型', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityId' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityType' => ['title' => 'leId/customerId', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'],
+ 'ContactName' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'example' => 'xxx'],
+ 'ContactEmail' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'example' => 'xxx@xxx.xx'],
+ 'ContactMobile' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'example' => '1xxxxxxxxxx'],
+ 'ContactPosition' => ['title' => '职位：', 'description' => '职位：', 'type' => 'string', 'example' => '4'],
+ 'EmailConfirmed' => ['title' => '邮箱已验证', 'description' => '邮箱已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'MobileConfirmed' => ['title' => '手机号已验证', 'description' => '手机号已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'SharedContact' => ['title' => '是否公共联系人', 'description' => '是否公共联系人', 'type' => 'boolean', 'example' => 'false'],
+ 'UpdateUser' => ['title' => '最后修改人', 'description' => '最后修改人', 'type' => 'string', 'example' => 'xxx'],
+ 'UpdateDate' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'HasSubscription' => ['title' => '查询联系人详情时是否订阅项目', 'description' => '查询联系人详情时是否订阅项目', 'type' => 'boolean', 'example' => 'xxx'],
+ 'Uid' => ['title' => '联系人归属人', 'description' => '联系人归属人', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
],
],
],
+ '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' => '查询账号联系人详情',
+ 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactQueryDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AccountContactQueryPageList' => [
+ 'summary' => '查询联系人列表。',
+ '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' => '页码 default 1', 'description' => '页码 default 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '页大小, default 10', 'description' => '页大小, default 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['title' => '姓名、邮箱、手机号', 'description' => '姓名、邮箱、手机号', 'type' => 'string', 'required' => false, 'example' => 'keyword'],
+ ],
+ [
+ 'name' => 'SharedContact',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否公共联系人', 'description' => '只查询公共联系人。当前接口默认set false。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'AppName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'OrientedLeId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'OrientedEcId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'OrientedNbId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'PrivateContact',
+ 'in' => 'formData',
+ 'schema' => ['description' => '只查询账号私有联系人。当前接口默认set true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'ShowCompleteInfo',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否显示完整信息', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'ListResult<ContactDTO>',
+ 'description' => 'ListResult<ContactDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID。',
- 'type' => 'string',
- 'example' => '36E0A548-4BA3-549B-8855-22E3F5C6D47E',
- ],
- 'Success' => [
- 'description' => '操作是否成功。true表示成功，false表示失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '消息。',
- 'type' => 'string',
- 'example' => 'Success',
- ],
+ 'TotalCount' => ['title' => '总数据量', 'description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'PageSize' => ['title' => '页大小', 'description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '19'],
+ 'PageNo' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'TotalPage' => ['title' => '总页码数', 'description' => '总页码数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '27A90A55-120A-59DC-812E-62448D440E95'],
+ 'Success' => ['description' => '是否调用成功。true：表示调用成功。false：表示调用失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '函数执行时，标准输出的日志内容', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '处理结果',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'description' => '操作结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '操作结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['title' => '联系人ID', 'description' => '联系人ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'CustomerId' => ['title' => '客户ID，兼容旧模型', 'description' => '客户ID，兼容旧模型', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityId' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityType' => ['title' => 'leId/customerId', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'],
+ 'ContactName' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'example' => 'xxx'],
+ 'ContactEmail' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'example' => 'xxx@xxx.xx'],
+ 'ContactMobile' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'example' => '1xxxxxxxxxx'],
+ 'ContactPosition' => ['title' => '职位：', 'description' => '职位：', 'type' => 'string', 'example' => '1'],
+ 'EmailConfirmed' => ['title' => '邮箱已验证', 'description' => '邮箱已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'MobileConfirmed' => ['title' => '手机号已验证', 'description' => '手机号已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'SharedContact' => ['title' => '是否公共联系人', 'description' => '是否公共联系人。', 'type' => 'boolean', 'example' => 'false'],
+ 'UpdateUser' => ['title' => '最后修改人', 'description' => '最后修改人', 'type' => 'string', 'example' => 'xxx'],
+ 'UpdateDate' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ ],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 200 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
+ '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' => '分页查询账号联系人',
+ 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。',
+ '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' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '删除企业联系人',
- 'description' => '删除企业公共联系人。主账号授权请参考[文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.744a1303wP4uCE&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)',
- 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。'."\n"
- .'- 当前接口仅能管理企业联系人。',
],
'EnterpriseContactAdd' => [
'summary' => '增加企业联系人。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1210,45 +665,22 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactName',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ContactEmail',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx@xxx.xx',
- ],
+ 'schema' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'],
],
[
'name' => 'ContactMobile',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'],
],
[
'name' => 'ContactPosition',
@@ -1258,113 +690,54 @@
'description' => '职位：',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'TECH_MANAGER技术负责人',
- 'MAINTAIN_MANAGER运维负责人',
- 'PROJECT_MANAGER项目负责人',
- 'FINANCE_MANAGER财务负责人',
- 'CEO',
- 'OTHER其它',
- ],
+ 'enumValueTitles' => ['TECH_MANAGER技术负责人', 'MAINTAIN_MANAGER运维负责人', 'PROJECT_MANAGER项目负责人', 'FINANCE_MANAGER财务负责人', 'CEO', 'OTHER其它'],
'example' => '1',
],
],
[
'name' => 'EmailCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '邮箱验证码',
- 'description' => '邮箱验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '邮箱验证码', 'description' => '邮箱验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'MobileCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '短信验证码',
- 'description' => '短信验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '短信验证码', 'description' => '短信验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'SharedContact',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人。当前接口默认set true。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否公共联系人。当前接口默认set true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'AsyncEmailVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AsyncMobileVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
@@ -1374,44 +747,16 @@
'description' => 'Result<ContactOperationDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '40EA3ECB-2167-5A8E-9327-F7E59E508FA8',
- ],
- 'Success' => [
- 'description' => '操作是否成功。true表示成功，false表示失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'OK',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '40EA3ECB-2167-5A8E-9327-F7E59E508FA8'],
+ 'Success' => ['description' => '操作是否成功。true表示成功，false表示失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'OK'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Successful!'],
'Data' => [
'description' => '当前分类统计的数据结果',
'type' => 'object',
'properties' => [
- 'Result' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'xxx',
- ],
- 'ContactId' => [
- 'title' => '联系人Id',
- 'description' => '联系人Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
+ 'Result' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'xxx'],
+ 'ContactId' => ['title' => '联系人Id', 'description' => '联系人Id', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
'ErrorList' => [
'description' => '错误状态信息。',
'type' => 'array',
@@ -1423,35 +768,17 @@
'title' => 'NAME, EMAIL, MOBILE, POSITION, EMAIL_VERIFY_CODE, MOBILE_VERIFY_CODE',
'description' => '异常字段',
'type' => 'string',
- 'enumValueTitles' => [
- 'POSITION' => 'POSITION',
- 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE',
- 'EMAIL' => 'EMAIL',
- 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE',
- 'NAME' => 'NAME',
- 'MOBILE' => 'MOBILE',
- ],
+ 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'],
'example' => 'MOBILE_VERIFY_CODE',
],
'ErrorCode' => [
'title' => 'NAME_ILLEGAL, EMAIL_FORMAT_ILLEGAL, MOBILE_FORMAT_ILLEGAL, MOBILE_CODE_ILLEGAL, EMAIL_CODE_ILLEGAL, POSITION_ILLEGAL',
'description' => '错误码',
'type' => 'string',
- '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',
- ],
+ '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'],
'example' => 'MOBILE_CODE_ILLEGAL',
],
- 'ErrorDesc' => [
- 'description' => '诊断问题的描述。',
- 'type' => 'string',
- 'example' => 'Mobile Code Illegal',
- ],
+ 'ErrorDesc' => ['description' => '诊断问题的描述。', 'type' => 'string', 'example' => 'Mobile Code Illegal'],
],
],
],
@@ -1463,14 +790,8 @@
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'No permission.',
- ],
- [
- 'errorCode' => 'ContactReachLimit',
- 'errorMessage' => 'The number of current account contacts has reached the upper limit.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ['errorCode' => 'ContactReachLimit', 'errorMessage' => 'The number of current account contacts has reached the upper limit.', 'description' => '当前账号联系人数量已达上限。'],
],
],
'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"}]',
@@ -1480,512 +801,111 @@
'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。'."\n"
.'- 接口调用走异步验证流程，配合接口SendAsyncMobileCaptcha/SendAsyncEmailCaptcha发送验证链接进行验证。不需要填写验证码。'."\n"
.'- 当前接口仅能管理企业联系人。',
- ],
- 'AccountContactQueryPageList' => [
- 'summary' => '查询联系人列表。',
- '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' => '页码 default 1',
- 'description' => '页码 default 1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页大小, default 10',
- 'description' => '页大小, default 10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '姓名、邮箱、手机号',
- 'description' => '姓名、邮箱、手机号',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'keyword',
- ],
- ],
- [
- 'name' => 'SharedContact',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '只查询公共联系人。当前接口默认set false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'AppName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'OrientedLeId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- ],
- [
- 'name' => 'OrientedEcId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- ],
- [
- 'name' => 'OrientedNbId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
- ],
- [
- 'name' => 'PrivateContact',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '只查询账号私有联系人。当前接口默认set true。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
- ],
- [
- 'name' => 'ShowCompleteInfo',
- 'in' => 'query',
- 'schema' => [
- 'description' => '是否不进行数据脱敏',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'ListResult<ContactDTO>',
- 'description' => 'ListResult<ContactDTO>',
- 'type' => 'object',
- 'properties' => [
- 'TotalCount' => [
- 'title' => '总数据量',
- 'description' => '总数据量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'PageSize' => [
- 'title' => '页大小',
- 'description' => '页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '19',
- ],
- 'PageNo' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'TotalPage' => [
- 'title' => '总页码数',
- 'description' => '总页码数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '27A90A55-120A-59DC-812E-62448D440E95',
- ],
- 'Success' => [
- 'description' => '是否调用成功。true：表示调用成功。false：表示调用失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '函数执行时，标准输出的日志内容',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '操作结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '操作结果',
- 'type' => 'object',
- 'properties' => [
- 'ContactId' => [
- 'title' => '联系人ID',
- 'description' => '联系人ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'CustomerId' => [
- 'title' => '客户ID，兼容旧模型',
- 'description' => '客户ID，兼容旧模型',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityId' => [
- 'title' => '实体ID',
- 'description' => '实体ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityType' => [
- 'title' => 'leId/customerId',
- 'description' => 'leId/customerId',
- 'type' => 'string',
- 'example' => 'customerId',
- ],
- 'ContactName' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ContactEmail' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'example' => 'xxx@xxx.xx',
- ],
- 'ContactMobile' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'example' => '1xxxxxxxxxx',
- ],
- 'ContactPosition' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'EmailConfirmed' => [
- 'title' => '邮箱已验证',
- 'description' => '邮箱已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MobileConfirmed' => [
- 'title' => '手机号已验证',
- 'description' => '手机号已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SharedContact' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人。',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UpdateUser' => [
- 'title' => '最后修改人',
- 'description' => '最后修改人',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'UpdateDate' => [
- 'title' => '最后修改时间',
- 'description' => '最后修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactAdd',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- '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' => '分页查询账号联系人',
- 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。',
],
- 'AccountContactQueryDetail' => [
- 'summary' => '查询联系人详情。',
- 'methods' => [
- 'post',
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'EnterpriseContactDelete' => [
+ 'summary' => '删除企业联系人。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '联系人ID。可以通过接口AccountContactQueryPageList分页查询',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '需要删除的联系人的ID。可调用EnterpriseQueryPageList分页查询账号联系人信息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'yanxuan',
- ],
+ 'schema' => ['description' => '应用名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<ContactDTO>',
- 'description' => 'Result<ContactDTO>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'DA632E90-32DB-52DE-823B-4A182169D954',
- ],
- 'Success' => [
- 'description' => '表示是否调用成功。true：调用成功。 false：调用失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
- 'Data' => [
- 'description' => '操作结果',
- 'type' => 'object',
- 'properties' => [
- 'ContactId' => [
- 'title' => '联系人ID',
- 'description' => '联系人ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'CustomerId' => [
- 'title' => '客户ID，兼容旧模型',
- 'description' => '客户ID，兼容旧模型',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityId' => [
- 'title' => '实体ID',
- 'description' => '实体ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'EntityType' => [
- 'title' => 'leId/customerId',
- 'description' => 'leId/customerId',
- 'type' => 'string',
- 'example' => 'customerId',
- ],
- 'ContactName' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ContactEmail' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'example' => 'xxx@xxx.xx',
- ],
- 'ContactMobile' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'example' => '1xxxxxxxxxx',
- ],
- 'ContactPosition' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'example' => '4',
- ],
- 'EmailConfirmed' => [
- 'title' => '邮箱已验证',
- 'description' => '邮箱已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MobileConfirmed' => [
- 'title' => '手机号已验证',
- 'description' => '手机号已验证',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SharedContact' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'UpdateUser' => [
- 'title' => '最后修改人',
- 'description' => '最后修改人',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'UpdateDate' => [
- 'title' => '最后修改时间',
- 'description' => '最后修改时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'HasSubscription' => [
- 'title' => '查询联系人详情时是否订阅项目',
- 'description' => '查询联系人详情时是否订阅项目',
- 'type' => 'boolean',
- 'example' => 'xxx',
- ],
- 'Uid' => [
- 'title' => '联系人归属人',
- 'description' => '联系人归属人',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求ID。', 'type' => 'string', 'example' => '36E0A548-4BA3-549B-8855-22E3F5C6D47E'],
+ 'Success' => ['description' => '操作是否成功。true表示成功，false表示失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'Success'],
+ 'Data' => ['description' => '处理结果', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- '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' => '查询账号联系人详情',
- 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。',
- ],
- 'AccountContactEdit' => [
- 'summary' => '修改私有联系人。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '删除企业联系人',
+ 'description' => '删除企业公共联系人。主账号授权请参考[文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.744a1303wP4uCE&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)',
+ 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。'."\n"
+ .'- 当前接口仅能管理企业联系人。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactDelete',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EnterpriseContactEdit' => [
+ 'summary' => '修改私企业联系人。',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1993,172 +913,77 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '联系人ID。可调用AccountContactQueryPageList分页查询账号联系人信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '需要修改的联系人的ID。可调用EnterpriseContactQueryPageList分页查询账号联系人信息。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ContactName',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ContactEmail',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx@xxx.xx',
- ],
+ 'schema' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'required' => false, 'example' => 'xxx@xxx.xx'],
],
[
'name' => 'ContactMobile',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'],
],
[
'name' => 'ContactPosition',
'in' => 'formData',
- 'schema' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'TECH_MANAGER技术负责人',
- 'MAINTAIN_MANAGER运维负责人',
- 'PROJECT_MANAGER项目负责人',
- 'FINANCE_MANAGER财务负责人',
- 'CEO',
- 'OTHER其它',
- ],
- 'example' => '0',
- ],
+ 'schema' => ['title' => '职位：', 'description' => '职位：', 'type' => 'string', 'required' => false, 'example' => '2'],
],
[
'name' => 'EmailCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '邮箱验证码',
- 'description' => '邮箱验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '邮箱验证码', 'description' => '邮箱验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'MobileCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '短信验证码',
- 'description' => '短信验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '短信验证码', 'description' => '短信验证码', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'SharedContact',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否企业联系人。当前接口默认set false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否公共联系人。当前接口默认set true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
'name' => 'AsyncEmailVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AsyncMobileVerify',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true'."\n",
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
@@ -2168,46 +993,18 @@
'description' => 'Result<ContactOperationDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2',
- ],
- 'Success' => [
- 'description' => '操作是否成功。取值：true：成功。false：失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '516C2364-18B7-5BAC-9288-AAEA85EEA351'],
+ 'Success' => ['description' => '操作是否成功。true表示成功，false表示失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '调用结果信息', 'type' => 'string', 'example' => 'SUCCESS'],
'Data' => [
'description' => '当前分类统计的数据结果',
'type' => 'object',
'properties' => [
- 'Result' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => '{\'TeamDesktops\': [], \'PrivateDesktops\': [], \'UnallocatedTeamDesktops\': []}',
- ],
- 'ContactId' => [
- 'title' => '联系人Id',
- 'description' => '联系人Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
+ 'Result' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'ContactId' => ['title' => '联系人Id', 'description' => '联系人Id', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
'ErrorList' => [
- 'description' => '错误码。',
+ 'description' => '备份服务器上报的错误信息。',
'type' => 'array',
'items' => [
'description' => '备份服务器上报的错误信息。',
@@ -2217,35 +1014,17 @@
'title' => 'NAME, EMAIL, MOBILE, POSITION, EMAIL_VERIFY_CODE, MOBILE_VERIFY_CODE',
'description' => '异常字段',
'type' => 'string',
- 'enumValueTitles' => [
- 'POSITION' => 'POSITION',
- 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE',
- 'EMAIL' => 'EMAIL',
- 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE',
- 'NAME' => 'NAME',
- 'MOBILE' => 'MOBILE',
- ],
+ 'enumValueTitles' => ['POSITION' => 'POSITION', 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE', 'EMAIL' => 'EMAIL', 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE', 'NAME' => 'NAME', 'MOBILE' => 'MOBILE'],
'example' => 'MOBILE_VERIFY_CODE',
],
'ErrorCode' => [
'title' => 'NAME_ILLEGAL, EMAIL_FORMAT_ILLEGAL, MOBILE_FORMAT_ILLEGAL, MOBILE_CODE_ILLEGAL, EMAIL_CODE_ILLEGAL, POSITION_ILLEGAL',
'description' => '错误码',
'type' => 'string',
- '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',
- ],
- 'example' => 'MOBILE_CODE_ILLEGAL',
- ],
- 'ErrorDesc' => [
- 'description' => '诊断问题的原因。',
- 'type' => 'string',
+ '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'],
'example' => 'MOBILE_CODE_ILLEGAL',
],
+ 'ErrorDesc' => ['description' => '诊断问题的描述。', 'type' => 'string', 'example' => 'Mobile Code Illegal'],
],
],
],
@@ -2255,418 +1034,611 @@
],
],
],
- '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' => '修改账号联系人',
- 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
- .'- 接口调用走异步验证流程，配合接口SendAsyncMobileCaptcha/SendAsyncEmailCaptcha发送验证链接进行验证。不需要填写验证码。'."\n"
- .'- 当前接口仅能管理账号联系人。',
- ],
- 'AccountContactDelete' => [
- 'summary' => '删除私有联系人。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '修改企业联系人',
+ 'description' => '修改企业公共联系人。主账号授权请参考[文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.744a1303wP4uCE&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)',
+ 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。'."\n"
+ .'- 接口调用走异步验证流程，配合接口SendAsyncMobileCaptcha/SendAsyncEmailCaptcha发送验证链接进行验证。不需要填写验证码。'."\n"
+ .'- 当前接口仅能管理企业联系人。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactEdit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EnterpriseContactQueryDetail' => [
+ 'summary' => '查询联系人详情。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'ContactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '需要删除的账号联系人的ID。可调用AccountContactQueryPageList分页查询账号联系人信息。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '联系人ID。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '应用名称。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<Boolean>',
- 'description' => 'Result<Boolean>',
+ 'title' => 'Result<ContactDTO>',
+ 'description' => 'Result<ContactDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '8CCD6B37-98E7-5A68-B1F7-A900C9BFF45C',
- ],
- 'Success' => [
- 'description' => '操作是否成功。true表示成功，false表示失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'Successful!',
- ],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'F81F2090-8260-5052-BB93-7DF8996D25EB'],
+ 'Success' => ['description' => '操作是否成功。true表示成功，false表示失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'Success'],
+ 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'description' => '结果数组',
- 'type' => 'boolean',
- 'example' => '{\'count\': 1}',
+ 'description' => '操作结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['title' => '联系人ID', 'description' => '联系人ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'xx'],
+ 'CustomerId' => ['title' => '客户ID，兼容旧模型', 'description' => '客户ID，兼容旧模型', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityId' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => '3489d3bc-077a-449b-b41e-dd81f7451a42'],
+ 'EntityType' => ['title' => 'leId/customerId', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'],
+ 'ContactName' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'example' => 'xxx'],
+ 'ContactEmail' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'example' => 'xx@xx.xx'],
+ 'ContactMobile' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'example' => '1xxxxxxxxxx'],
+ 'ContactPosition' => ['title' => '职位：', 'description' => '职位：', 'type' => 'string', 'example' => '4'],
+ 'EmailConfirmed' => ['title' => '邮箱已验证', 'description' => '邮箱已验证', 'type' => 'boolean', 'example' => 'false'],
+ 'MobileConfirmed' => ['title' => '手机号已验证', 'description' => '手机号已验证', 'type' => 'boolean', 'example' => 'false'],
+ 'SharedContact' => ['title' => '是否公共联系人', 'description' => '是否公共联系人', 'type' => 'boolean', 'example' => 'false'],
+ 'UpdateUser' => ['title' => '最后修改人', 'description' => '最后修改人', 'type' => 'string', 'example' => 'xxx'],
+ 'UpdateDate' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'HasSubscription' => ['title' => '查询联系人详情时是否订阅项目', 'description' => '查询联系人详情时是否订阅项目', 'type' => 'boolean', 'example' => 'xxx'],
+ 'Uid' => ['title' => '联系人归属人', 'description' => '联系人归属人', 'type' => 'string', 'example' => 'xxx'],
+ ],
],
],
],
],
],
- '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' => '删除账号联系人',
- 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
- .'- 当前接口仅能管理账号联系人。',
- ],
- 'AccountContactAdd' => [
- 'summary' => '创建账号联系人。',
- 'methods' => [
- 'post',
- 'get',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ],
],
- 'schemes' => [
- 'https',
+ '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' => '查询企业联系人详情',
+ 'description' => '查询单个企业联系人详情。',
+ 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactQueryDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'EnterpriseContactQueryPageList' => [
+ 'summary' => '查询联系人列表。',
+ 'methods' => ['get', 'post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
- 'name' => 'ContactName',
+ 'name' => 'PageNo',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人姓名',
- 'description' => '联系人姓名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '页码 default 1', 'description' => '页码 default 1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ContactEmail',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人邮箱',
- 'description' => '联系人邮箱',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx@xxx.xxx',
- ],
+ 'schema' => ['title' => '页大小, default 10', 'description' => '页大小, default 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ContactMobile',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'title' => '联系人手机',
- 'description' => '联系人手机',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1xxxxxxxxxx',
- ],
+ 'schema' => ['title' => '姓名、邮箱、手机号', 'description' => '姓名、邮箱、手机号', 'type' => 'string', 'required' => false, 'example' => '1xxxxxxxxxx'],
],
[
- 'name' => 'ContactPosition',
+ 'name' => 'SharedContact',
'in' => 'formData',
- 'schema' => [
- 'title' => '职位：',
- 'description' => '职位：',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'TECH_MANAGER技术负责人',
- 'MAINTAIN_MANAGER运维负责人',
- 'PROJECT_MANAGER项目负责人',
- 'FINANCE_MANAGER财务负责人',
- 'CEO',
- 'OTHER其它',
- ],
- 'example' => '0',
- ],
+ 'schema' => ['title' => '是否公共联系人', 'description' => '是否公共联系人。当前接口默认set true。', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
],
[
- 'name' => 'EmailCode',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'title' => '邮箱验证码',
- 'description' => '邮箱验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '客户端应用名称。', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'MobileCode',
+ 'name' => 'OrientedLeId',
'in' => 'formData',
- 'schema' => [
- 'title' => '短信验证码',
- 'description' => '短信验证码',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '当前切换到的企业', 'description' => '当前切换到的企业', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
- 'name' => 'SharedContact',
+ 'name' => 'OrientedEcId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否公共联系人。当前接口默认set false。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- 'default' => 'false',
- ],
+ 'schema' => ['description' => '跨企业管理对象实体id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
- 'name' => 'AsyncEmailVerify',
+ 'name' => 'OrientedNbId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验邮箱。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncEmailCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['description' => '跨企业管理对象售卖场id', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
[
- 'name' => 'AsyncMobileVerify',
+ 'name' => 'PrivateContact',
'in' => 'formData',
+ 'schema' => ['description' => '私有联系人查询标志位。当前接口默认set false', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false'],
+ ],
+ [
+ 'name' => 'ShowCompleteInfo',
+ 'in' => 'query',
+ 'schema' => ['description' => '是否显示完整信息', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '是否公共联系人',
- 'description' => '是否异步校验手机号。api调用需要为true。否则将同步强校验验证码。通过接口SendAsyncMobileCaptcha发送验证链接。',
- 'type' => 'boolean',
- 'required' => false,
+ 'title' => 'ListResult<ContactDTO>',
+ 'description' => 'ListResult<ContactDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'TotalCount' => ['title' => '总数据量', 'description' => '总数据量', 'type' => 'integer', 'format' => 'int32', 'example' => '11'],
+ 'PageSize' => ['title' => '页大小', 'description' => '页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageNo' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TotalPage' => ['title' => '总页码数', 'description' => '总页码数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => 'C0A6196F-52A0-5EC9-B8D3-263CEF806EC4'],
+ 'Success' => ['description' => '操作是否成功。取值：true：成功。false：失败。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => 'msg', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'description' => '操作结果',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '操作结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ContactId' => ['title' => '联系人ID', 'description' => '联系人ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ 'CustomerId' => ['title' => '客户ID，兼容旧模型', 'description' => '客户ID，兼容旧模型', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityId' => ['title' => '实体ID', 'description' => '实体ID', 'type' => 'string', 'example' => 'xxx'],
+ 'EntityType' => ['title' => 'leId/customerId', 'description' => 'leId/customerId', 'type' => 'string', 'example' => 'customerId'],
+ 'ContactName' => ['title' => '联系人姓名', 'description' => '联系人姓名', 'type' => 'string', 'example' => '曾老师'],
+ 'ContactEmail' => ['title' => '联系人邮箱', 'description' => '联系人邮箱', 'type' => 'string', 'example' => 'xx@xx.xx'],
+ 'ContactMobile' => ['title' => '联系人手机', 'description' => '联系人手机', 'type' => 'string', 'example' => '1xxxxxxxxxx'],
+ 'ContactPosition' => ['title' => '职位：', 'description' => '职位：', 'type' => 'string', 'example' => '1'],
+ 'EmailConfirmed' => ['title' => '邮箱已验证', 'description' => '邮箱已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'MobileConfirmed' => ['title' => '手机号已验证', 'description' => '手机号已验证', 'type' => 'boolean', 'example' => 'true'],
+ 'SharedContact' => ['title' => '是否公共联系人', 'description' => '是否公共联系人', 'type' => 'boolean', 'example' => 'false'],
+ 'UpdateUser' => ['title' => '最后修改人', 'description' => '最后修改人', 'type' => 'string', 'example' => 'xx'],
+ 'UpdateDate' => ['title' => '最后修改时间', 'description' => '最后修改时间', 'type' => 'integer', 'format' => 'int64', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ],
+ ],
+ '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' => '分页查询企业联系人',
+ 'description' => '分页查询企业联系人。',
+ 'requestParamsDescription' => 'OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。该功能目前还未开放。相关参数为空即可。',
+ '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' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'SendAsyncEmailCaptcha' => [
+ 'summary' => '发送邮箱异步校验邮件，用于验证指定联系人的邮箱。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'ContactInfo',
+ 'in' => 'formData',
+ 'schema' => ['description' => '联系方式', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'ContactorId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '联系人id', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
[
'name' => 'AppName',
'in' => 'formData',
+ 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '应用名',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['description' => '请求ID', 'type' => 'string', 'example' => '5E9636D3-6C10-5FAB-B391-EDD122E28BC6'],
+ 'Success' => ['description' => '请求成功与否标识。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'Instance invalid-id-123 does not exist.'],
+ 'Data' => ['description' => '操作结果', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'VerifyCodeSendTimesOverLimited', 'errorMessage' => 'Verify Code Send Times Over Limited.', 'description' => '验证码发送次数超出频次限制,请稍后再试'],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'No permission.', 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ['errorCode' => 'AsyncVerifyContactNotFound', 'errorMessage' => 'Contact does not exist or has been deleted.', 'description' => '联系人不存在或已被删除。'],
+ ['errorCode' => 'AsyncVerifyEmailMismatch', 'errorMessage' => 'The request mailbox is not consistent with the contact mailbox.', 'description' => '请求邮箱与联系人邮箱不一致。'],
+ ],
+ ],
+ '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' => '发送邮箱异步校验邮件',
+ 'description' => '发送联系人联系方式的异步验证链接。 存在额外流控。5分钟內同一账号+联系方式不超过20次。24小时內同一账号全局不超过300次。',
+ 'requestParamsDescription' => '联系人id需要在当前请求账号可管理的联系人范围内。参考[地址联系人文档](https://help.aliyun.com/zh/account/add-personal-addresses-and-personal-contacts?spm=a2c4g.11186623.help-menu-35469.d_2_4.307a1738vMufL7&scm=20140722.H_2618535._.OR_help-T_cn~zh-V_1)以及[企业地址联系人文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.a5ca1738qFvysM&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:SendAsyncEmailCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ ],
+ 'SendAsyncMobileCaptcha' => [
+ 'summary' => '发送手机号异步校验短信，用于验证指定联系人的手机号。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'OrientedLeId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'ContactInfo',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前切换到的企业',
- 'description' => '当前切换到的企业',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '联系方式', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'OrientedEcId',
+ 'name' => 'ContactorId',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象实体id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '联系人id', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'OrientedNbId',
+ 'name' => 'AppName',
'in' => 'formData',
- 'schema' => [
- 'description' => '跨企业管理对象售卖场id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['description' => '应用名', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Result<ContactOperationDTO>',
- 'description' => 'Result<ContactOperationDTO>',
+ 'title' => 'Result<Boolean>',
+ 'description' => 'Result<Boolean>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => 'E4E192DF-798B-58AE-B8BF-EBC15E2E85F2',
- ],
- 'Success' => [
- 'description' => '操作是否成功。取值：true：成功。false：失败。',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '接口返回信息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'description' => '当前分类统计的数据结果',
- 'type' => 'object',
- 'properties' => [
- 'Result' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'ContactId' => [
- 'title' => '联系人Id',
- 'description' => '联系人Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'xxx',
- ],
- 'ErrorList' => [
- 'description' => '错误状态信息。',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误状态信息。',
- 'type' => 'object',
- 'properties' => [
- 'Item' => [
- 'title' => 'NAME, EMAIL, MOBILE, POSITION, EMAIL_VERIFY_CODE, MOBILE_VERIFY_CODE',
- 'description' => '异常字段',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'POSITION' => 'POSITION',
- 'MOBILE_VERIFY_CODE' => 'MOBILE_VERIFY_CODE',
- 'EMAIL' => 'EMAIL',
- 'EMAIL_VERIFY_CODE' => 'EMAIL_VERIFY_CODE',
- 'NAME' => 'NAME',
- 'MOBILE' => 'MOBILE',
- ],
- 'example' => 'MOBILE_VERIFY_CODE',
- ],
- 'ErrorCode' => [
- 'title' => 'NAME_ILLEGAL, EMAIL_FORMAT_ILLEGAL, MOBILE_FORMAT_ILLEGAL, MOBILE_CODE_ILLEGAL, EMAIL_CODE_ILLEGAL, POSITION_ILLEGAL',
- 'description' => '错误码',
- 'type' => 'string',
- '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',
- ],
- 'example' => 'MOBILE_CODE_ILLEGAL',
- ],
- 'ErrorDesc' => [
- 'description' => '诊断问题的原因。',
- 'type' => 'string',
- 'example' => 'MOBILE_CODE_ILLEGAL',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['description' => '请求的唯一标识符。', 'type' => 'string', 'example' => '1409E8EE-8F9A-506B-BACB-B9DF3634C287'],
+ 'Success' => ['description' => '请求成功与否标识。', 'type' => 'boolean', 'example' => 'True'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Message' => ['description' => '消息。', 'type' => 'string', 'example' => 'success'],
+ 'Data' => ['description' => '操作结果', 'type' => 'boolean', 'example' => 'False'],
],
],
],
],
'errorCodes' => [
200 => [
- [
- 'errorCode' => 'ContactReachLimit',
- 'errorMessage' => 'The number of current account contacts has reached the upper limit.',
+ ['errorCode' => 'VerifyCodeSendTimesOverLimited', 'errorMessage' => 'Verify Code Send Times Over Limited.', 'description' => '验证码发送次数超出频次限制,请稍后再试'],
+ ['errorCode' => 'AsyncVerifyContactNotFound', 'errorMessage' => 'Contact does not exist or has been deleted.', 'description' => '联系人不存在或已被删除。'],
+ ['errorCode' => 'AsyncVerifyMobileMismatch', 'errorMessage' => 'The request phone number is inconsistent with the contact phone number.', 'description' => '请求手机号与联系人手机号不一致。'],
+ ],
+ ],
+ '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' => '发送手机号异步校验短信',
+ 'description' => '发送联系人联系方式的异步验证链接。 存在额外流控。5分钟內同一账号+联系方式不超过20次。24小时內同一账号全局不超过300次。',
+ 'requestParamsDescription' => '联系人id需要在当前请求账号可管理的联系人范围内。参考[地址联系人文档](https://help.aliyun.com/zh/account/add-personal-addresses-and-personal-contacts?spm=a2c4g.11186623.help-menu-35469.d_2_4.307a1738vMufL7&scm=20140722.H_2618535._.OR_help-T_cn~zh-V_1)以及[企业地址联系人文档](https://help.aliyun.com/zh/account/user-guide/add-business-address-and-business-contact?spm=a2c4g.11186623.help-menu-35469.d_7_0_5.a5ca1738qFvysM&scm=20140722.H_2879086._.OR_help-T_cn~zh-V_1)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:SendAsyncMobileCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- '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' => '创建账号联系人',
- 'description' => '创建账号联系人',
- 'requestParamsDescription' => '- OrientedLeId/OrientedEcId/OrientedNbId 为跨企业管理场景使用。账号联系人相关场景不涉及，相关参数为空即可。'."\n"
- .'- 当前接口仅能管理账号联系人。',
],
],
'endpoints' => [
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'accountcenter.aliyuncs.com',
+ ['regionId' => 'ap-southeast-1', 'regionName' => '新加坡', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'accountcenter-intl.aliyuncs.com', 'endpoint' => 'accountcenter-intl.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1（杭州）', 'areaId' => 'asiaPacific', 'areaName' => '亚太', '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' => '联系人不存在或已被删除。'],
+ ['code' => 'AsyncVerifyEmailMismatch', 'message' => 'The request mailbox is not consistent with the contact mailbox.', 'http_code' => 200, 'description' => '请求邮箱与联系人邮箱不一致。'],
+ ['code' => 'AsyncVerifyMobileMismatch', 'message' => 'The request phone number is inconsistent with the contact phone number.', 'http_code' => 200, 'description' => '请求手机号与联系人手机号不一致。'],
+ ['code' => 'ContactReachLimit', 'message' => 'The number of current account contacts has reached the upper limit.', 'http_code' => 200, 'description' => '当前账号联系人数量已达上限。'],
+ ['code' => 'EmailConflict', 'message' => 'Email is duplicated.', 'http_code' => 200, 'description' => '登录邮箱冲突，已存在对应的阿里云账号'],
+ ['code' => 'LoginIdInBlackList', 'message' => 'Login ID is in black list.', 'http_code' => 200, 'description' => '当前邮箱对应的登录名在黑名单中，请更换一个邮箱'],
+ ['code' => 'NoPermission', 'message' => 'No permission.', 'http_code' => 200, 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ['code' => 'NO_PERMISSION', 'message' => 'No permission.', 'http_code' => 200, 'description' => '无权限。请检查您的企业多账号权限以及相关访问策略是否授予。检查请求的资源是否有权限管理。'],
+ ['code' => 'PasswordIsSameAsLast', 'message' => 'password can\'t be the same with last password.', 'http_code' => 200, 'description' => '修改后密码不能和当前密码相同'],
+ ['code' => 'PasswordIsSameAsPrevious3OldPassword', 'message' => 'password can\'t be the same with previous 3 times password.', 'http_code' => 200, 'description' => '新输入的密码不能和过去使用过的三次密码相同'],
+ ['code' => 'VerifyCodeSendTimesOverLimited', 'message' => 'Verify Code Send Times Over Limited.', 'http_code' => 200, 'description' => '验证码发送次数超出频次限制,请稍后再试'],
+ ['code' => 'VERIFY_CODE_SEND_TIMES_OVER_LIMITED', 'message' => 'VERIFY CODE SEND TIMES OVER LIMITED.', 'http_code' => 200, 'description' => '验证码发送次数超出频次限制,请稍后再试'],
+ ],
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AccountContactQueryPageList'],
+ ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnterpriseContactQueryPageList'],
],
- [
- 'regionId' => 'ap-southeast-1',
- 'endpoint' => 'accountcenter-intl.aliyuncs.com',
+ ],
+ 'ram' => [
+ 'productCode' => 'AccountCenter',
+ 'productName' => '账号中心',
+ 'ramCodes' => ['accountcenter'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'AccountContactDelete',
+ 'description' => '删除账号联系人',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactDelete',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendAsyncMobileCaptcha',
+ 'description' => '发送手机号异步校验短信',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:SendAsyncMobileCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SendAsyncEmailCaptcha',
+ 'description' => '发送邮箱异步校验邮件',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:SendAsyncEmailCaptcha',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnterpriseContactDelete',
+ 'description' => '删除企业联系人',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactDelete',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AccountContactAdd',
+ 'description' => '创建账号联系人',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactAdd',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnterpriseContactEdit',
+ 'description' => '修改企业联系人',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactEdit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnterpriseContactQueryDetail',
+ 'description' => '查询企业联系人详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactQueryDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnterpriseContactQueryPageList',
+ 'description' => '分页查询企业联系人',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactQueryPageList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AccountContactQueryPageList',
+ 'description' => '分页查询账号联系人',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactQueryPageList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AccountContactEdit',
+ 'description' => '修改账号联系人',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactEdit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EnterpriseContactAdd',
+ 'description' => '创建企业联系人',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'accountcenter:EnterpriseContactAdd',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AccountContactQueryDetail',
+ 'description' => '查询账号联系人详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'accountcenter:AccountContactQueryDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AccountCenter', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];
generated by cgit v1.2.3 (git 2.46.0) at 2026-07-12 21:40:38 +0000