diff options
Diffstat (limited to 'data/en_us/support-plan')
| -rw-r--r-- | data/en_us/support-plan/2021-07-06/api-docs.php | 670 |
1 files changed, 670 insertions, 0 deletions
diff --git a/data/en_us/support-plan/2021-07-06/api-docs.php b/data/en_us/support-plan/2021-07-06/api-docs.php new file mode 100644 index 0000000..30c5dae --- /dev/null +++ b/data/en_us/support-plan/2021-07-06/api-docs.php @@ -0,0 +1,670 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'support-plan', + 'version' => '2021-07-06', + ], + 'directories' => [ + [ + 'id' => 133327, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListEnterpriseDingtalkGroupCustomerMembers', + 'AddEnterpriseGroupMemberToTaskGroup', + 'ListEnterpriseDingtalkGroups', + ], + ], + [ + 'id' => 133333, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateTaskOrder', + 'ListDdTaskOrder', + 'ListProductByGroup', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'EnterpriseDingtalkGroupMember' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'object', + 'properties' => [ + 'IsAdmin' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'boolean', + 'example' => 'true', + 'backendName' => 'isAdmin', + ], + 'Mobile' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => '130xxxxxxxx', + 'backendName' => 'mobile', + ], + 'Name' => [ + 'title' => '', + 'description' => '', + 'visibility' => 'public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'name', + ], + ], + ], + ], + ], + 'apis' => [ + 'ListEnterpriseDingtalkGroupCustomerMembers' => [ + 'summary' => '获取钉群中所有客户侧人员信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'OpenGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '企业服务群ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的唯一ID, 每次调用requestID唯一', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'Success' => [ + 'title' => '调用接口返回是否成功, true代表调用正常', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '错误信息, 当success=false的时候, 可以取到message', + 'description' => '', + 'type' => 'string', + 'example' => 'Invalid data', + ], + 'Code' => [ + 'title' => '接口请求结果返回码', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/EnterpriseDingtalkGroupMember', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'type' => 'string', + ], + 'IsAdmin' => [ + 'type' => 'boolean', + ], + 'UserId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"123\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Invalid data\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Name\\": \\"云小宝\\",\\n \\"IsAdmin\\": true,\\n \\"UserId\\": \\"PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs=\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEnterpriseDingtalkGroupCustomerMembersResponse>\\n <RequestId>123</RequestId>\\n <Success>true</Success>\\n <Message>Invalid data</Message>\\n <Code>200</Code>\\n <Data>\\n <IsAdmin>true</IsAdmin>\\n <Mobile>130xxxxxxxx</Mobile>\\n <Name>张三</Name>\\n </Data>\\n</ListEnterpriseDingtalkGroupCustomerMembersResponse>","errorExample":""}]', + ], + 'AddEnterpriseGroupMemberToTaskGroup' => [ + 'summary' => '添加客户服务主群人员进子群', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs=', + ], + ], + [ + 'name' => 'TaskOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'E240815B72K5D3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => '43135C31-E47A-5AD7-A693-6DC635201CE4', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'ok', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"43135C31-E47A-5AD7-A693-6DC635201CE4\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"ok\\",\\n \\"Code\\": \\"200\\",\\n \\"Data\\": \\"true\\"\\n}","type":"json"}]', + ], + 'ListEnterpriseDingtalkGroups' => [ + 'summary' => '查询所有企业钉群成员', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '接口请求的唯一ID, 每次调用requestID唯一', + 'description' => '', + 'type' => 'string', + 'example' => '12xxxxx', + ], + 'Success' => [ + 'title' => '调用接口返回是否成功, true代表调用正常', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => '错误信息, 当success=false的时候, 可以取到message', + 'description' => '', + 'type' => 'string', + 'example' => 'Data Invalid', + ], + 'Code' => [ + 'title' => '接口请求结果返回码', + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'title' => '服务钉群数组', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OpenGroupId' => [ + 'title' => '钉群ID', + 'description' => '', + 'type' => 'string', + 'example' => '123', + ], + 'GroupName' => [ + 'title' => '钉群名', + 'description' => '', + 'type' => 'string', + 'example' => 'A公司服务群', + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"12xxxxx\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"Data Invalid\\",\\n \\"Code\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"OpenGroupId\\": \\"123\\",\\n \\"GroupName\\": \\"A公司服务群\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListEnterpriseDingtalkGroupsResponse>\\n <RequestId>12xxxxx</RequestId>\\n <Success>true</Success>\\n <Message>Data Invalid</Message>\\n <Code>true</Code>\\n <Data>\\n <OpenGroupId>123</OpenGroupId>\\n <GroupName>A公司服务群</GroupName>\\n </Data>\\n</ListEnterpriseDingtalkGroupsResponse>","errorExample":""}]', + ], + 'CreateTaskOrder' => [ + 'summary' => '创建工单', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'OpenGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '主群关联Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cid+lUpHxTIXt7DYqJDcpVxlA==', + ], + ], + [ + 'name' => 'UrgentDescription', + 'in' => 'query', + 'schema' => [ + 'title' => '重要性描述', + 'type' => 'string', + 'required' => false, + 'example' => '重要性描述', + ], + ], + [ + 'name' => 'IsUrgent', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'Overview', + 'in' => 'query', + 'schema' => [ + 'title' => '任务单标题', + 'type' => 'string', + 'required' => true, + 'example' => '任务单标题：必填', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'title' => 'productType', + 'type' => 'string', + 'required' => true, + 'example' => 'ecs', + ], + ], + [ + 'name' => 'CreateUserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'msg', + 'description' => 'msg', + 'type' => 'string', + 'example' => 'ok', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '123', + ], + 'Data' => [ + 'title' => '返回任务单号：OrderId', + 'description' => '', + 'type' => 'string', + 'example' => 'E21111796147LE', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'code', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"ok\\",\\n \\"RequestId\\": \\"43135C31-E47A-5AD7-A693-6DC635201CE4\\",\\n \\"Data\\": \\"E21111796147LE\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateTaskOrderResponse>\\n <Message>ok</Message>\\n <RequestId>43135C31-E47A-5AD7-A693-6DC635201CE4</RequestId>\\n <Data>E21111796147LE</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateTaskOrderResponse>","errorExample":""}]', + ], + 'ListDdTaskOrder' => [ + 'summary' => 'ListDdTaskOrder', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OpenGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'openGroupId', + 'description' => 'openGroupId', + 'type' => 'string', + 'required' => true, + 'example' => 'DAWNN14N', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => [ + 'title' => 'taskStatus', + 'description' => 'taskStatus', + 'type' => 'string', + 'required' => false, + 'example' => 'dealingNode', + ], + ], + [ + 'name' => 'CreateRealName', + 'in' => 'query', + 'schema' => [ + 'description' => 'createRealName', + 'type' => 'string', + 'required' => false, + 'example' => 'Tom', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'startTime', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-01 14:09:11', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'endTime', + 'type' => 'string', + 'required' => false, + 'example' => '2024-08-20 14:09:16', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'pageSize', + 'type' => 'integer', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'format' => 'int64', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => 'pageNo', + 'type' => 'integer', + 'required' => false, + 'example' => '1', + 'default' => '1', + 'format' => 'int64', + ], + ], + [ + 'name' => 'IsUrgent', + 'in' => 'query', + 'schema' => [ + 'type' => 'boolean', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'msg', + 'description' => 'msg', + 'type' => 'string', + 'example' => '请求成功', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '2F8557E4-742B-1CF7-8E83-28CD0C1F7B48', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'string', + 'example' => '{ "msg": "请求成功", "code": "200", "data": [ { "wfNodeId": "dealingNode",//任务单状态 "createEmpId": null,//创建人工号，可以忽略 "createTime": 1637571435000,//任务单创建时间 "orderId": "E2111221H1UKCZ",//任务单号 "isImportant": "normal",//是否紧急 "closeTime": null,//任务单关单时间 "taskTitle": "测试单16点44",//标题 "productType": "3270"//问题分类 }, { "wfNodeId": "dealingNode", "createEmpId": null, "createTime": 1637820497000, "orderId": "E211125CG111EM", "isImportant": "normal", "closeTime": null, "taskTitle": "测试单14", "class": "com.aliyun.dingtalklanding.dto.OpenTaskOrderDTO", "productType": "3270" } ], "success": true, "requestId": "123", "class": "com.aliyun.dingtalklanding.pop.dto.PopResultDTO" }', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'code', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"2F8557E4-742B-1CF7-8E83-28CD0C1F7B48\\",\\n \\"Data\\": \\"[\\\\n {\\\\n \\\\\\"taskStatus\\\\\\": \\\\\\"处理中\\\\\\",\\\\n \\\\\\"taskOrderId\\\\\\": \\\\\\"E240815B72K5D3\\\\\\",\\\\n \\\\\\"startNo\\\\\\": \\\\\\"5星\\\\\\",\\\\n \\\\\\"createRealName\\\\\\": \\\\\\"云小宝\\\\\\",\\\\n \\\\\\"feedback\\\\\\": \\\\\\"对客总结\\\\\\",\\\\n \\\\\\"groupName\\\\\\": \\\\\\"测试主群\\\\\\",\\\\n \\\\\\"createTime\\\\\\": \\\\\\"2024-08-15T20:43Z\\\\\\",\\\\n \\\\\\"firstConfirmedTime\\\\\\": \\\\\\"2024-08-18T15:25Z\\\\\\",\\\\n \\\\\\"isUrgent\\\\\\": \\\\\\"normal\\\\\\",\\\\n \\\\\\"closeTime\\\\\\": \\\\\\"2024-08-21T16:25Z\\\\\\",\\\\n \\\\\\"taskTitle\\\\\\": \\\\\\"测试建单\\\\\\",\\\\n \\\\\\"productName\\\\\\": \\\\\\"云服务器 ECS\\\\\\",\\\\n \\\\\\"chatId\\\\\\": \\\\\\"chatb728b275a0056e516ed7798cf4e5dabd\\\\\\"\\\\n }\\\\n]\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListDdTaskOrderResponse>\\n <Message>请求成功</Message>\\n <RequestId>2F8557E4-742B-1CF7-8E83-28CD0C1F7B48</RequestId>\\n <Data>[ { \\"wfNodeId\\":\\"dealingNode\\", \\"createEmpId\\":null, \\"createTime\\":1637571435000, \\"orderId\\":\\"E2111221H1UKCZ\\", \\"isImportant\\":\\"normal\\", \\"closeTime\\":null, \\"taskTitle\\":\\"测试单16点44\\", \\"productType\\":\\"3270\\" } ]</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListDdTaskOrderResponse>","errorExample":""}]', + 'title' => 'ListDdTaskOrder', + ], + 'ListProductByGroup' => [ + 'summary' => '获取问题分类', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'OpenGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '主群关联Id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'cidXcezGVQJjiWy2PzXylGwvg==', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'msg', + 'description' => 'msg', + 'type' => 'string', + 'example' => '请求成功', + ], + 'RequestId' => [ + 'title' => '接口交互动态值', + 'description' => 'requestId', + 'type' => 'string', + 'example' => '123', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'string', + 'example' => '[ { "wfNodeId": "dealingNode",//任务单状态 "createEmpId": null,//创建人工号，可以忽略 "createTime": 1637571435000,//任务单创建时间 "orderId": "E2111221H1UKCZ",//任务单号 "isImportant": "normal",//是否紧急 "closeTime": null,//任务单关单时间 "taskTitle": "测试单16点44",//标题 "productType": "3270"//问题分类 }, { "wfNodeId": "dealingNode", "createEmpId": null, "createTime": 1637820497000, "orderId": "E211125CG111EM", "isImportant": "normal", "closeTime": null, "taskTitle": "测试单14", "class": "com.aliyun.dingtalklanding.dto.OpenTaskOrderDTO", "productType": "3270" } ]', + ], + 'Code' => [ + 'title' => 'code', + 'description' => 'code', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'title' => 'success', + 'description' => 'success', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"请求成功\\",\\n \\"RequestId\\": \\"43135C31-E47A-5AD7-A693-6DC635201CE4\\",\\n \\"Data\\": \\"[\\\\n {\\\\n \\\\\\"productName\\\\\\": \\\\\\"ECS\\\\\\",\\\\n \\\\\\"productCode\\\\\\": \\\\\\"ecs\\\\\\"\\\\n }\\\\n ]\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListProductByGroupResponse>\\n <Message>请求成功</Message>\\n <RequestId>123</RequestId>\\n <Data>[ { \\"classificationProductTypeId\\":3270, \\"classificationProductName\\":\\"伏虎测试组\\", \\"classificationProductDesc\\":\\"伏虎测试组\\", \\"classificationProductTypeName\\":\\"lc-云享咨询\\", \\"id\\":462, \\"enabled\\":1 } ]</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListProductByGroupResponse>","errorExample":""}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'supportplan.aliyuncs.com', + ], + ], +]; |