'1.0',
'info' => [
'style' => 'RPC',
'product' => 'support-plan',
'version' => '2021-07-06',
],
'directories' => [
[
'id' => 133327,
'title' => '企业服务群',
'type' => 'directory',
'children' => [
'ListEnterpriseDingtalkGroupCustomerMembers',
'AddEnterpriseGroupMemberToTaskGroup',
'ListEnterpriseDingtalkGroups',
],
],
[
'id' => 133333,
'title' => '任务单管理',
'type' => 'directory',
'children' => [
'CreateTaskOrder',
'ListDdTaskOrder',
'ListProductByGroup',
],
],
],
'components' => [
'schemas' => [
'EnterpriseDingtalkGroupMember' => [
'title' => '企业服务群成员信息',
'description' => '企业服务群成员',
'type' => 'object',
'properties' => [
'IsAdmin' => [
'title' => '是否企业钉群管理员',
'description' => '是否为管理员',
'type' => 'boolean',
'example' => 'true',
],
'Mobile' => [
'title' => '成员手机号',
'description' => '成员电话',
'type' => 'string',
'example' => '130xxxxxxxx',
],
'Name' => [
'title' => '成员姓名',
'description' => '成员姓名',
'type' => 'string',
'example' => '张三',
],
],
],
],
],
'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' => '企业服务群ID',
'type' => 'string',
'required' => true,
'example' => 'DAWNN14N',
],
],
],
'responses' => [
200 => [
'schema' => [
'type' => 'object',
'properties' => [
'RequestId' => [
'title' => '接口请求的唯一ID, 每次调用requestID唯一',
'description' => '接口请求的唯一ID, 每次调用requestID唯一',
'type' => 'string',
'example' => '123',
],
'Success' => [
'title' => '调用接口返回是否成功, true代表调用正常',
'description' => '调用接口返回是否成功, true代表调用正常',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误信息, 当success=false的时候, 可以取到message',
'description' => '错误信息, 当success=false的时候, 可以取到message',
'type' => 'string',
'example' => 'Invalid data',
],
'Code' => [
'title' => '接口请求结果返回码',
'description' => '接口请求结果返回码',
'type' => 'string',
'example' => '200',
],
'Data' => [
'description' => '企业服务群成员列表',
'type' => 'array',
'items' => [
'description' => '成员详情',
'type' => 'object',
'properties' => [
'Name' => [
'description' => '企业服务群成员名称',
'type' => 'string',
'example' => '云小宝',
],
'IsAdmin' => [
'description' => '是否为企业服务群管理员',
'type' => 'boolean',
'example' => 'true',
],
'UserId' => [
'description' => '企业服务群成员唯一标识',
'type' => 'string',
'example' => 'PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs=',
],
],
],
],
],
],
],
],
'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":"\\n 123\\n true\\n Invalid data\\n 200\\n \\n true\\n 130xxxxxxxx\\n 张三\\n \\n","errorExample":""}]',
'title' => '获取企业服务群成员列表',
],
'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' => '企业服务群成员唯一标识,取值来源于[获取企业服务群成员列表](https://help.aliyun.com/document_detail/2845070.html?spm=a2c4g.11186623.help-menu-44216.d_5_2_0_0.3acc74ddxlAIc5&scm=20140722.H_2845070._.OR_help-T_cn~zh-V_1)',
'type' => 'string',
'required' => true,
'example' => 'PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs=',
],
],
[
'name' => 'TaskOrderId',
'in' => 'query',
'schema' => [
'description' => '任务单号,取值来源于[获取任务单列表](https://help.aliyun.com/document_detail/2845075.html?spm=a2c4g.11186623.help-menu-44216.d_5_2_1_1.7e1142c5V9A7Rj&scm=20140722.H_2845075._.OR_help-T_cn~zh-V_1)',
'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' => '接口交互 id。',
'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"}]',
'title' => '添加企业服务群成员进任务单群',
],
'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' => '接口请求的唯一ID, 每次调用requestID唯一',
'type' => 'string',
'example' => '12xxxxx',
],
'Success' => [
'title' => '调用接口返回是否成功, true代表调用正常',
'description' => '调用接口返回是否成功, true代表调用正常',
'type' => 'boolean',
'example' => 'true',
],
'Message' => [
'title' => '错误信息, 当success=false的时候, 可以取到message',
'description' => '错误信息, 当success=false的时候, 可以取到message',
'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' => '企业服务群ID',
'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":"\\n 12xxxxx\\n true\\n Data Invalid\\n true\\n \\n 123\\n A公司服务群\\n \\n","errorExample":""}]',
'title' => '获取企业服务群列表',
],
'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' => '企业服务群ID',
'type' => 'string',
'required' => true,
'example' => '9NWTWRBY',
],
],
[
'name' => 'UrgentDescription',
'in' => 'query',
'schema' => [
'title' => '重要性描述',
'description' => '紧急程度描述',
'type' => 'string',
'required' => false,
'example' => '数据不可用',
],
],
[
'name' => 'IsUrgent',
'in' => 'query',
'schema' => [
'description' => '是否紧急',
'type' => 'boolean',
'required' => false,
'example' => 'false',
],
],
[
'name' => 'Overview',
'in' => 'query',
'schema' => [
'title' => '任务单标题',
'description' => '问题概述',
'type' => 'string',
'required' => true,
'example' => '测试建单',
],
],
[
'name' => 'ProductCode',
'in' => 'query',
'schema' => [
'title' => 'productType',
'description' => '产品分类,取值来源于[获取产品列表](https://help.aliyun.com/document_detail/2845077.html?spm=a2c4g.2845070.0.0.65793d29K9abVt)',
'type' => 'string',
'required' => true,
'example' => 'ecs',
],
],
[
'name' => 'CreateUserId',
'in' => 'query',
'schema' => [
'description' => '建单人唯一标识,取值来源于[获取企业服务群成员列表](https://help.aliyun.com/document_detail/2845070.html?spm=a2c4g.2845077.0.0.3ad274ddlIJdaT)',
'type' => 'string',
'required' => true,
'example' => 'PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs=',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'msg',
'description' => '接口请求描述',
'type' => 'string',
'example' => 'ok',
],
'RequestId' => [
'title' => 'requestId',
'description' => '接口交互id',
'type' => 'string',
'example' => '43135C31-E47A-5AD7-A693-6DC635201CE4',
],
'Data' => [
'title' => '返回任务单号:OrderId',
'description' => '任务单号',
'type' => 'string',
'example' => 'E21111796147LE',
],
'Code' => [
'title' => 'code',
'description' => '状态值',
'type' => 'string',
'example' => '200',
],
'Success' => [
'title' => 'success',
'description' => '请求接口是否成功',
'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":"\\n ok\\n 43135C31-E47A-5AD7-A693-6DC635201CE4\\n E21111796147LE\\n 200\\n true\\n","errorExample":""}]',
'title' => '创建任务单',
'requestParamsDescription' => '{'."\n"
.' "OpenGroupId": "9NWTWRBY",'."\n"
.' "UrgentDescription": "紧急度测试",'."\n"
.' "IsUrgent": true,'."\n"
.' "Overview": "建单测试",'."\n"
.' "ProductCode": "ecs",'."\n"
.' "CreateUserId": "PtWoW82DJI1zcTwsT98kLIgAj7kfASzfC6StcpV7hKs="'."\n"
.'}',
'responseParamsDescription' => '返回结果data 为任务单ID,后续其他接口操作也会用到',
],
'ListDdTaskOrder' => [
'summary' => '获取获取任务订单列表。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'OpenGroupId',
'in' => 'query',
'schema' => [
'title' => 'openGroupId',
'description' => '企业服务群ID,可在企业服务台开发接入处获取,必填项',
'type' => 'string',
'required' => true,
'example' => 'DAWNN14N',
],
],
[
'name' => 'TaskStatus',
'in' => 'query',
'schema' => [
'title' => 'taskStatus',
'description' => '任务单状态',
'type' => 'string',
'required' => false,
'example' => '处理中',
],
],
[
'name' => 'CreateRealName',
'in' => 'query',
'schema' => [
'description' => '创建人姓名',
'type' => 'string',
'required' => false,
'example' => '云小宝',
],
],
[
'name' => 'StartTime',
'in' => 'query',
'schema' => [
'description' => '开始时间,用于筛选任务单创建时间',
'type' => 'string',
'required' => false,
'example' => '2024-08-01 14:09:11',
],
],
[
'name' => 'EndTime',
'in' => 'query',
'schema' => [
'description' => '结束时间,用于筛选任务单创建时间',
'type' => 'string',
'required' => false,
'example' => '2024-08-20 14:09:16',
],
],
[
'name' => 'PageSize',
'in' => 'query',
'schema' => [
'description' => '分页参数,每页查询数量,默认为10',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '10',
],
],
[
'name' => 'PageNo',
'in' => 'query',
'schema' => [
'description' => '分页参数,页码,默认为1',
'type' => 'integer',
'format' => 'int64',
'required' => false,
'example' => '1',
],
],
[
'name' => 'IsUrgent',
'in' => 'query',
'schema' => [
'description' => '是否紧急',
'type' => 'boolean',
'required' => false,
'example' => 'true',
],
],
],
'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' => '['."\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"
.']',
],
'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":"\\n 请求成功\\n 2F8557E4-742B-1CF7-8E83-28CD0C1F7B48\\n [ { \\"wfNodeId\\":\\"dealingNode\\", \\"createEmpId\\":null, \\"createTime\\":1637571435000, \\"orderId\\":\\"E2111221H1UKCZ\\", \\"isImportant\\":\\"normal\\", \\"closeTime\\":null, \\"taskTitle\\":\\"测试单16点44\\", \\"productType\\":\\"3270\\" } ]\\n 200\\n true\\n","errorExample":""}]',
'title' => '获取任务单列表',
'responseParamsDescription' => '['."\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"
.']',
],
'ListProductByGroup' => [
'summary' => '根据产品组获取产品列表(主要是获取产品id)。',
'methods' => [
'post',
],
'schemes' => [
'http',
'https',
],
'security' => [
[
'AK' => [],
],
],
'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
],
'parameters' => [
[
'name' => 'OpenGroupId',
'in' => 'query',
'schema' => [
'title' => '主群关联Id',
'description' => '企业服务群ID',
'type' => 'string',
'required' => true,
'example' => '9NWTWRBY',
],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'result',
'description' => 'result',
'type' => 'object',
'properties' => [
'Message' => [
'title' => 'msg',
'description' => '返回描述,成功或失败',
'type' => 'string',
'example' => '请求成功',
],
'RequestId' => [
'title' => '接口交互动态值',
'description' => '接口交互请求id',
'type' => 'string',
'example' => '43135C31-E47A-5AD7-A693-6DC635201CE4',
],
'Data' => [
'title' => 'data',
'description' => '产品分类数据',
'type' => 'string',
'example' => '['."\n"
.' {'."\n"
.' "productName": "ECS",'."\n"
.' "productCode": "ecs"'."\n"
.' }'."\n"
.' ]',
],
'Code' => [
'title' => 'code',
'description' => '返回值编码',
'type' => 'string',
'example' => '200',
],
'Success' => [
'title' => 'success',
'description' => '是否成功',
'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":"\\n 请求成功\\n 123\\n [ { \\"classificationProductTypeId\\":3270, \\"classificationProductName\\":\\"伏虎测试组\\", \\"classificationProductDesc\\":\\"伏虎测试组\\", \\"classificationProductTypeName\\":\\"lc-云享咨询\\", \\"id\\":462, \\"enabled\\":1 } ]\\n 200\\n true\\n","errorExample":""}]',
'title' => '获取产品列表',
],
],
'endpoints' => [
[
'regionId' => 'cn-shanghai',
'endpoint' => 'supportplan.aliyuncs.com',
],
],
];