diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/en_us/scsp | |
| download | acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.tar.gz acs-metadata-full-7347bac4ab7e136157fc94777e6cf87ef9e08599.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/en_us/scsp')
| -rw-r--r-- | data/en_us/scsp/2020-07-02/api-docs.php | 15655 |
1 files changed, 15655 insertions, 0 deletions
diff --git a/data/en_us/scsp/2020-07-02/api-docs.php b/data/en_us/scsp/2020-07-02/api-docs.php new file mode 100644 index 0000000..c2edef5 --- /dev/null +++ b/data/en_us/scsp/2020-07-02/api-docs.php @@ -0,0 +1,15655 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'scsp', + 'version' => '2020-07-02', + ], + 'directories' => [ + [ + 'id' => 102934, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryHotlineDashboard', + ], + ], + [ + 'id' => 102936, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryServicerById', + 'QueryServicerByDepartmentAndMixName', + 'CreateAgent', + 'DeleteAgent', + 'UpdateAgent', + 'GetAgent', + 'GetHotlineAgentDetail', + 'ListAgentBySkillGroupId', + 'ListOutboundPhoneNumber', + 'GetHotlineWaitingNumber', + 'TransferCallToAgent', + ], + ], + [ + 'id' => 102939, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetAllDepartment', + ], + ], + [ + 'id' => 102941, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateOuterCallCenterData', + 'StartHotlineService', + 'ListHotlineRecord', + 'QueryHotlineSession', + 'GetHotlineAgentDetailReport', + 'GetHotlineAgentStatus', + 'GetHotlineGroupDetailReport', + 'GetOuterCallCenterDataList', + 'SendHotlineHeartBeat', + 'SuspendHotlineService', + 'TransferCallToPhone', + 'TransferCallToSkillGroup', + 'TransferToThirdCall', + 'FinishHotlineService', + ], + ], + [ + 'id' => 102966, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateRole', + 'DisableRole', + 'EnableRole', + ], + ], + [ + 'id' => 102970, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateTicket', + 'UpdateTicket', + 'QueryTicketActions', + 'QueryTicketCount', + 'QueryTickets', + 'SearchTicketById', + 'SearchTicketByPhone', + 'SearchTicketList', + 'AssignTicket', + 'CloseTicket', + 'ExecuteActivity', + ], + ], + [ + 'id' => 102982, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AnswerCall', + 'AppMessagePush', + 'ChangeChatAgentStatus', + 'CreateCustomer', + 'CreateEntityIvrRoute', + 'CreateSkillGroup', + 'CreateSubTicket', + 'CreateThirdSsoAgent', + 'createTicketWithBizData', + 'DeleteEntityRoute', + 'EditEntityRoute', + 'FetchCall', + 'GenerateWebSocketSign', + 'GetAuthInfo', + 'GetByForeignId', + 'GetCallsPerDay', + 'GetCMSIdByForeignId', + 'GetEntityRoute', + 'GetEntityRouteList', + 'GetEntityTagRelation', + 'GetGrantedRoleIds', + 'GetNumLocation', + 'GetOutbounNumList', + 'GetTagList', + 'GetTicketByCaseId', + 'GetTicketTemplateSchema', + 'GetUserToken', + 'GrantRoles', + 'HangupCall', + 'HangupThirdCall', + 'HoldCall', + 'JoinThirdCall', + 'ListSkillGroup', + 'QueryRelationTickets', + 'QueryRingDetailList', + 'QueryServiceConfig', + 'QuerySkillGroups', + 'RemoveSkillGroup', + 'SendOutboundCommand', + 'StartCall', + 'StartCallV2', + 'StartChatWork', + 'UpdateCustomer', + 'UpdateEntityTagRelation', + 'UpdateRingStatus', + 'UpdateRole', + 'UpdateSkillGroup', + 'ListAllHotLineSkillGroups', + 'AnwserAgentMonitor', + 'GetForeignIdByCMSId', + 'HangUpAgentMonitor', + 'StartAgentMonitor', + 'BindAgentHotlinePhone', + 'GetHotlineAgentDetailWithChannel', + 'GetAgentHotlinePhone', + 'GetAgentHotline', + 'UnbindAgentHotlinePhone', + 'GetAgentWorkStatus', + 'SendVerificationCode', + 'StartHotlineWork', + 'FinishHotlineServiceNew', + 'GetOnlineTouchSessionList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'QueryHotlineDashboard' => [ + 'summary' => '查询薪资面板', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'A short description of struct', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_***', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'title' => '开始时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1636473600000', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'title' => 'j结束时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1636473600000', + ], + ], + [ + 'name' => 'DepartmentIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '部门标识列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ServicerIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '坐席标识列表', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + 'required' => false, + ], + ], + [ + 'name' => 'SortFieldList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '排序字段集合', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + 'required' => false, + ], + ], + [ + 'name' => 'CurrentPageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '当前页码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页面大小', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '', + 'type' => 'string', + 'example' => 'ccc_xp_pre-cn-***', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'successful', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '查询结果条数', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Results' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DateId' => [ + 'title' => '日期', + 'description' => '', + 'type' => 'string', + 'example' => '20211101', + ], + 'ServicerId' => [ + 'title' => '坐席标识', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '727272', + ], + 'ServicerShowName' => [ + 'title' => '坐席对外展示名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ServicerRealName' => [ + 'title' => '坐席真实姓名', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'DepartmentId' => [ + 'title' => '部门标识', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11212121', + ], + 'DepartmentName' => [ + 'title' => '部门名称', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'EffectiveInCalls' => [ + 'title' => '有效呼入量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'EffectiveInServiceNotes' => [ + 'title' => '有效呼入小计量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '9', + ], + 'EffectiveOutCalls' => [ + 'title' => '有效外呼量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'EffectiveOutServiceNotes' => [ + 'title' => '有效外呼小计量', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + ], + ], + ], + ], + ], + 'HttpStatusCode' => [ + 'title' => 'http状态编码', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ccc_xp_pre-cn-***\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"Total\\": 100,\\n \\"Results\\": [\\n {\\n \\"DateId\\": \\"20211101\\",\\n \\"ServicerId\\": 727272,\\n \\"ServicerShowName\\": \\"加油-小高\\",\\n \\"ServicerRealName\\": \\"加油-小高\\",\\n \\"DepartmentId\\": 11212121,\\n \\"DepartmentName\\": \\"加油组\\",\\n \\"EffectiveInCalls\\": 10,\\n \\"EffectiveInServiceNotes\\": 9,\\n \\"EffectiveOutCalls\\": 20,\\n \\"EffectiveOutServiceNotes\\": 12\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<QueryHotlineDashboardResponse>\\n <RequestId>ccc_xp_pre-cn-***</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <Data>\\n <Total>100</Total>\\n <Results>\\n <DateId>20211101</DateId>\\n <ServicerId>727272</ServicerId>\\n <ServicerShowName>加油-小高</ServicerShowName>\\n <ServicerRealName>加油-小高</ServicerRealName>\\n <DepartmentId>11212121</DepartmentId>\\n <DepartmentName>加油组</DepartmentName>\\n <EffectiveInCalls>10</EffectiveInCalls>\\n <EffectiveInServiceNotes>9</EffectiveInServiceNotes>\\n <EffectiveOutCalls>20</EffectiveOutCalls>\\n <EffectiveOutServiceNotes>12</EffectiveOutServiceNotes>\\n </Results>\\n </Data>\\n <HttpStatusCode>200</HttpStatusCode>\\n</QueryHotlineDashboardResponse>","errorExample":""}]', + 'title' => 'QueryHotlineDashboard', + ], + 'QueryServicerById' => [ + 'summary' => '根据坐席标识查询坐席详细信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'ServicerId', + 'in' => 'query', + 'schema' => [ + 'title' => '坐席标识', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Code' => [ + 'title' => '状态码', + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'ServicerId' => [ + 'title' => '坐席标识', + 'type' => 'integer', + 'format' => 'int64', + ], + 'RealName' => [ + 'title' => '真实名称', + 'type' => 'string', + ], + 'UserStatus' => [ + 'title' => '用户状态:0正常 1冻结 2删除 -2临时冻结', + 'type' => 'integer', + 'format' => 'int32', + ], + 'ShowName' => [ + 'title' => '对外展示名', + 'type' => 'string', + ], + 'AccountName' => [ + 'title' => '登录名', + 'type' => 'string', + ], + 'DepartmentId' => [ + 'title' => '部门标识', + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + 'QueryServicerByDepartmentAndMixName' => [ + 'summary' => '分页查询客服信息通过部门和关键字', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'DepartmentIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '部门标识列表', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + 'example' => '905', + ], + ], + ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => [ + 'title' => '关键字', + 'type' => 'string', + ], + ], + [ + 'name' => 'CurrentPageNum', + 'in' => 'query', + 'schema' => [ + 'title' => '页码', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '页大小', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServicerId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RealName' => [ + 'type' => 'string', + ], + 'UserStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ShowName' => [ + 'type' => 'string', + ], + 'AccountName' => [ + 'type' => 'string', + ], + 'DepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'CreateAgent' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => 'js sdk中自动生成的鉴权token', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'format' => 'int64', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'format' => 'int64', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123456,145678', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666666', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoSkillGroupSetFound', + 'errorMessage' => 'The specified skill group set does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 666666,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>666666</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'DeleteAgent' => [ + 'methods' => [ + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'UpdateAgent' => [ + 'methods' => [ + 'put', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetAgent' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AgentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '222222', + ], + 'GroupList' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ChannelType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SkillGroupId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'TenantId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 222222,\\n \\"GroupList\\": [\\n {\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"Description\\": \\"自动化技能组\\",\\n \\"ChannelType\\": 1,\\n \\"SkillGroupId\\": 123456,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"TenantId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0,\\n \\"Message\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <Status>0</Status>\\n <DisplayName>刘测试</DisplayName>\\n <AgentId>222222</AgentId>\\n <GroupList>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>1</ChannelType>\\n <SkillGroupId>123456</SkillGroupId>\\n <Name>自动化技能组</Name>\\n </GroupList>\\n <AccountName>[email protected]</AccountName>\\n <TenantId>0</TenantId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetHotlineAgentDetail' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AgentStatusCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'AgentCheckout', + ], + 'Token' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', + ], + 'AgentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'Assigned' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'RestType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AgentStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TenantId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"AgentStatusCode\\": \\"AgentCheckout\\",\\n \\"Token\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"AgentId\\": 555555,\\n \\"Assigned\\": false,\\n \\"RestType\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"TenantId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <AgentStatusCode>AgentCheckout</AgentStatusCode>\\n <Token>dnthF_oinHg7JMJDmKqex3UxDD7</Token>\\n <AgentId>555555</AgentId>\\n <Assigned>false</Assigned>\\n <RestType>1</RestType>\\n <AgentStatus>1</AgentStatus>\\n <TenantId>0</TenantId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ListAgentBySkillGroupId' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '666666', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'AgentId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '666666', + ], + 'AccountName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'TenantId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 666666,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"TenantId\\": 0\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <Status>0</Status>\\n <DisplayName>刘测试</DisplayName>\\n <AgentId>666666</AgentId>\\n <AccountName>[email protected]</AccountName>\\n <TenantId>0</TenantId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ListOutboundPhoneNumber' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{9065446}', + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n \\"{9065446}\\"\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>{9065446}</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetHotlineWaitingNumber' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>2</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'TransferCallToAgent' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'TargetAccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetAllDepartment' => [ + 'summary' => '获取指定租户下的部门列表', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentName' => [ + 'type' => 'string', + ], + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'CreateOuterCallCenterData' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a15ce370-1051-4040-9822', + ], + ], + [ + 'name' => 'InterveneTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '16085570', + ], + ], + [ + 'name' => 'CallType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FromPhoneNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '135615', + ], + ], + [ + 'name' => 'ToPhoneNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0571773', + ], + ], + [ + 'name' => 'EndReason', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"level\\":25,\\"name\\":\\"Lee\\"}', + ], + ], + [ + 'name' => 'RecordUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'SHOP_ID', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '78604', + ], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"isCallBack\\":\\"true\\"}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'StartHotlineService' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0079e7a845e37334ff', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"0079e7a845e37334ff\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>0079e7a845e37334ff</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ListHotlineRecord' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '100365558', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '16128694810', + ], + 'StartTime' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => '16128694110', + ], + 'ConnectionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100365548', + ], + 'CallId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100365558', + ], + 'Url' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"EndTime\\": true,\\n \\"StartTime\\": true,\\n \\"ConnectionId\\": \\"100365548\\",\\n \\"CallId\\": \\"100365558\\",\\n \\"Url\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <EndTime>false</EndTime>\\n <StartTime>false</StartTime>\\n <ConnectionId>100365548</ConnectionId>\\n <CallId>100365558</CallId>\\n <Url>http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com</Url>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QueryHotlineSession' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Acid', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + ], + ], + [ + 'name' => 'CallType', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'default' => '', + 'enum' => [ + '1', + '2', + ], + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'default' => '', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MemberName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'QueryEndTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'default' => '', + ], + ], + [ + 'name' => 'QueryStartTime', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'default' => '', + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServicerName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServicerId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'CallResult', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'enum' => [ + 'normal', + 'touchRouteError', + 'touchInQueue', + 'touchInLoss', + 'userHangup', + 'sysHangup', + 'transferAgent', + 'dailing', + 'TouchRingCallLoss', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageNumber' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalCount' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CallDetailRecord' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallResult' => [ + 'type' => 'string', + ], + 'ServicerName' => [ + 'type' => 'string', + ], + 'OutQueueTime' => [ + 'type' => 'string', + ], + 'CallContinueTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'PickUpTime' => [ + 'type' => 'string', + ], + 'RingContinueTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CalledNumber' => [ + 'type' => 'string', + ], + 'ServicerId' => [ + 'type' => 'string', + ], + 'HangUpTime' => [ + 'type' => 'string', + ], + 'EvaluationLevel' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'HangUpRole' => [ + 'type' => 'string', + ], + 'MemberName' => [ + 'type' => 'string', + ], + 'EvaluationScore' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Acid' => [ + 'type' => 'string', + ], + 'RingStartTime' => [ + 'type' => 'string', + ], + 'CallType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'GroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'RingEndTime' => [ + 'type' => 'string', + ], + 'CallingNumber' => [ + 'type' => 'string', + ], + 'InQueueTime' => [ + 'type' => 'string', + ], + 'MemberId' => [ + 'type' => 'string', + ], + 'QueueUpContinueTime' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetHotlineAgentDetailReport' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Page' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Title' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Rows' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetHotlineAgentStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"通话中\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>通话中</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetHotlineGroupDetailReport' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '1000', + 'minimum' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'default' => '', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Page' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'type' => 'string', + ], + 'Title' => [ + 'type' => 'string', + ], + ], + ], + ], + 'Rows' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetOuterCallCenterDataList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'a15ce370-1051-4040-9822', + ], + ], + [ + 'name' => 'FromPhoneNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '135615', + ], + ], + [ + 'name' => 'ToPhoneNum', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0571773', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '78604', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'QueryStartTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1614824872', + ], + ], + [ + 'name' => 'QueryEndTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1614824972', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndReason' => [ + 'description' => '', + 'type' => 'string', + 'example' => '3', + ], + 'CallType' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Acid' => [ + 'description' => '', + 'type' => 'string', + 'example' => '100365558', + ], + 'ToPhoneNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0571773', + ], + 'UserInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"level\\":25,\\"name\\":\\"Lee\\"}', + ], + 'InterveneTime' => [ + 'description' => '', + 'type' => 'string', + 'example' => '16085570', + ], + 'BizId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '78604', + ], + 'SessionId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'a15ce370-1051-4040-9822', + ], + 'FromPhoneNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '135615', + ], + 'ExtInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{\\"isCallBack\\":\\"true\\"}', + ], + 'BizType' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'SHOP_ID', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"EndReason\\": \\"3\\",\\n \\"CallType\\": \\"1\\",\\n \\"Acid\\": \\"100365558\\",\\n \\"ToPhoneNum\\": \\"0571773\\",\\n \\"UserInfo\\": \\"{\\\\\\\\\\\\\\"level\\\\\\\\\\\\\\":25,\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Lee\\\\\\\\\\\\\\"}\\",\\n \\"InterveneTime\\": \\"16085570\\",\\n \\"BizId\\": \\"78604\\",\\n \\"SessionId\\": \\"a15ce370-1051-4040-9822\\",\\n \\"FromPhoneNum\\": \\"135615\\",\\n \\"ExtInfo\\": \\"{\\\\\\\\\\\\\\"isCallBack\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"true\\\\\\\\\\\\\\"}\\",\\n \\"BizType\\": \\"SHOP_ID\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <EndReason>3</EndReason>\\n <CallType>1</CallType>\\n <Acid>100365558</Acid>\\n <ToPhoneNum>0571773</ToPhoneNum>\\n <UserInfo>{\\\\\\"level\\\\\\":25,\\\\\\"name\\\\\\":\\\\\\"Lee\\\\\\"}</UserInfo>\\n <InterveneTime>16085570</InterveneTime>\\n <BizId>78604</BizId>\\n <SessionId>a15ce370-1051-4040-9822</SessionId>\\n <FromPhoneNum>135615</FromPhoneNum>\\n <ExtInfo>{\\\\\\"isCallBack\\\\\\":\\\\\\"true\\\\\\"}</ExtInfo>\\n <BizType>SHOP_ID</BizType>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'SendHotlineHeartBeat' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0079e7a845e37334ff', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'SuspendHotlineService' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'TransferCallToPhone' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Caller', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '9065446', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '136098792', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'callerPhone', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'calleePhone', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'TransferCallToSkillGroup' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '356543', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'TransferToThirdCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'FinishHotlineService' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'CreateRole' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'PermissionId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Data' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'DisableRole' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '555555', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'EnableRole' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '555555', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'CreateTicket' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '546754', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '10000', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '555555', + ], + ], + [ + 'name' => 'CreatorType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '4', + ], + ], + [ + 'name' => 'CreatorName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '-1', + ], + ], + [ + 'name' => 'MemberName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'FromInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'manual', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '4', + ], + ], + [ + 'name' => 'CarbonCopy', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '234432', + ], + ], + [ + 'name' => 'FormData', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500000010', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2500000010,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateTicket' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2500000010', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '555555', + ], + ], + [ + 'name' => 'FormData', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QueryTicketActions' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ActionCodeList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [], + 'responseDemo' => null, + ], + 'QueryTicketCount' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '666666', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '45', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'GetTenantIdFailed', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"45\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>45</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QueryTickets' => [ + 'summary' => '查询工单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'CaseType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'CaseStatus', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1000', + ], + ], + [ + 'name' => 'SrType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-10000000', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-10000000', + ], + ], + [ + 'name' => 'TouchId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + ], + ], + [ + 'name' => 'DealId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'required' => false, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'ParentCaseId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'StartCaseGmtCreate', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'EndCaseGmtCreate', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '1', + 'default' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '5000', + 'minimum' => '0', + 'default' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'SearchTicketById' => [ + 'summary' => '查询工单信息', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2500000010', + ], + ], + [ + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '12001', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CarbonCopy' => [ + 'description' => '', + 'type' => 'string', + 'example' => '234432', + ], + 'MemberName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'TicketId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500000010', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'FormData' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Activities' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ActivityFormData' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ActivityCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'finish', + ], + ], + ], + ], + 'ActivityRecords' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ActionCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '997015', + ], + 'ActionCodeDesc' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'OperatorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Operator' => [ + 'type' => 'string', + ], + 'Memo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'GmtCreate' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824772', + ], + ], + ], + ], + 'FromInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hotline', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'CreatorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CreatorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MemberId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876543', + ], + 'CaseStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TemplateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '546754', + ], + 'TicketName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ParentCaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"CarbonCopy\\": \\"234432\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"CreateTime\\": 1614824872,\\n \\"ServiceId\\": 555555,\\n \\"TicketId\\": 2500000010,\\n \\"Priority\\": 1,\\n \\"CreatorId\\": 555555,\\n \\"FormData\\": \\"{\\\\\\"questionInfo\\\\\\":\\\\\\"自动化创建工单\\\\\\"}\\",\\n \\"Activities\\": [\\n {\\n \\"ActivityFormData\\": \\"{\\\\\\\\\\\\\\"BQ73dGsSNs\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"备注\\\\\\\\\\\\\\"}\\",\\n \\"ActivityCode\\": \\"finish\\"\\n }\\n ],\\n \\"ActivityRecords\\": [\\n {\\n \\"ActionCode\\": \\"997015\\",\\n \\"ActionCodeDesc\\": \\"创建工单\\",\\n \\"OperatorName\\": \\"刘测试\\",\\n \\"Operator\\": \\"\\",\\n \\"Memo\\": \\"{\\\\\\"CFQyYAPjKb\\\\\\":\\\\\\"开胶\\\\\\"}\\",\\n \\"GmtCreate\\": 1614824772\\n }\\n ],\\n \\"FromInfo\\": \\"hotline\\",\\n \\"ModifiedTime\\": 1614824872,\\n \\"CreatorName\\": \\"刘测试\\",\\n \\"CategoryId\\": 10000,\\n \\"CreatorType\\": 4,\\n \\"MemberId\\": 1876543,\\n \\"CaseStatus\\": 6,\\n \\"TemplateId\\": 546754,\\n \\"TicketName\\": \\"自动化工单\\",\\n \\"ParentCaseId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <CarbonCopy>234432</CarbonCopy>\\n <MemberName>匿名会员</MemberName>\\n <CreateTime>1614824872</CreateTime>\\n <ServiceId>555555</ServiceId>\\n <TicketId>2500000010</TicketId>\\n <Priority>1</Priority>\\n <CreatorId>555555</CreatorId>\\n <FormData>{\\"questionInfo\\":\\"自动化创建工单\\"}</FormData>\\n <Activities>\\n <ActivityFormData>{\\\\\\"BQ73dGsSNs\\\\\\":\\\\\\"备注\\\\\\"}</ActivityFormData>\\n <ActivityCode>finish</ActivityCode>\\n </Activities>\\n <ActivityRecords>\\n <ActionCode>997015</ActionCode>\\n <ActionCodeDesc>创建工单</ActionCodeDesc>\\n <OperatorName>刘测试</OperatorName>\\n <Memo>{\\"CFQyYAPjKb\\":\\"开胶\\"}</Memo>\\n <GmtCreate>1614824772</GmtCreate>\\n </ActivityRecords>\\n <FromInfo>hotline</FromInfo>\\n <ModifiedTime>1614824872</ModifiedTime>\\n <CreatorName>刘测试</CreatorName>\\n <CategoryId>10000</CategoryId>\\n <CreatorType>4</CreatorType>\\n <MemberId>1876543</MemberId>\\n <CaseStatus>6</CaseStatus>\\n <TemplateId>546754</TemplateId>\\n <TicketName>自动化工单</TicketName>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'SearchTicketByPhone' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '138999', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '546754', + ], + ], + [ + 'name' => 'TicketStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '6', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '10', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1614824872', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1614825972', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'OnePageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '16', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CarbonCopy' => [ + 'description' => '', + 'type' => 'string', + 'example' => '234432', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'TicketId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500000010', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'FormData' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FromInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hotline', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreatorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CreatorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MemberId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876543', + ], + 'CaseStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TemplateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '546754', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OnePageSize\\": 10,\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"TotalPage\\": 2,\\n \\"TotalResults\\": 16,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"CarbonCopy\\": \\"234432\\",\\n \\"CreateTime\\": 1614824872,\\n \\"ServiceId\\": 555555,\\n \\"TicketId\\": 2500000010,\\n \\"Priority\\": 1,\\n \\"CreatorId\\": 555555,\\n \\"FormData\\": \\"{\\\\\\"questionInfo\\\\\\":\\\\\\"自动化创建工单\\\\\\"}\\",\\n \\"FromInfo\\": \\"hotline\\",\\n \\"ModifiedTime\\": 1614824872,\\n \\"TaskStatus\\": \\"处理中\\",\\n \\"CreatorName\\": \\"刘测试\\",\\n \\"CategoryId\\": 10000,\\n \\"CreatorType\\": 4,\\n \\"MemberId\\": 1876543,\\n \\"CaseStatus\\": 6,\\n \\"TemplateId\\": 546754\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<OnePageSize>10</OnePageSize>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<TotalPage>2</TotalPage>\\n<TotalResults>16</TotalResults>\\n<PageNo>1</PageNo>\\n<Data>\\n <MemberName>匿名会员</MemberName>\\n <CarbonCopy>234432</CarbonCopy>\\n <CreateTime>1614824872</CreateTime>\\n <ServiceId>555555</ServiceId>\\n <TicketId>2500000010</TicketId>\\n <Priority>1</Priority>\\n <CreatorId>555555</CreatorId>\\n <FormData>{\\"questionInfo\\":\\"自动化创建工单\\"}</FormData>\\n <FromInfo>hotline</FromInfo>\\n <ModifiedTime>1614824872</ModifiedTime>\\n <TaskStatus>处理中</TaskStatus>\\n <CreatorName>刘测试</CreatorName>\\n <CategoryId>10000</CategoryId>\\n <CreatorType>4</CreatorType>\\n <MemberId>1876543</MemberId>\\n <CaseStatus>6</CaseStatus>\\n <TemplateId>546754</TemplateId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'SearchTicketList' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '555555', + ], + ], + [ + 'name' => 'TicketStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '20', + 'default' => '20', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1614824872', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '1614825972', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'OnePageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TotalResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '45', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'MemberName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CarbonCopy' => [ + 'description' => '', + 'type' => 'string', + 'example' => '234432', + ], + 'CreateTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'ServiceId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'TicketId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500000010', + ], + 'Priority' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CreatorId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '555555', + ], + 'FormData' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'FromInfo' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'hotline', + ], + 'ModifiedTime' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614824872', + ], + 'TaskStatus' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CreatorName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'CategoryId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CreatorType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'MemberId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1876543', + ], + 'CaseStatus' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '6', + ], + 'TemplateId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '546754', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OnePageSize\\": 20,\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"TotalPage\\": 3,\\n \\"TotalResults\\": 45,\\n \\"PageNo\\": 1,\\n \\"Data\\": [\\n {\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"CarbonCopy\\": \\"234432\\",\\n \\"CreateTime\\": 1614824872,\\n \\"ServiceId\\": 555555,\\n \\"TicketId\\": 2500000010,\\n \\"Priority\\": 1,\\n \\"CreatorId\\": 555555,\\n \\"FormData\\": \\"{\\\\\\"questionInfo\\\\\\":\\\\\\"自动化创建工单\\\\\\"}\\",\\n \\"FromInfo\\": \\"hotline\\",\\n \\"ModifiedTime\\": 1614824872,\\n \\"TaskStatus\\": \\"处理中\\",\\n \\"CreatorName\\": \\"刘测试\\",\\n \\"CategoryId\\": 10000,\\n \\"CreatorType\\": 4,\\n \\"MemberId\\": 1876543,\\n \\"CaseStatus\\": 6,\\n \\"TemplateId\\": 546754\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<OnePageSize>20</OnePageSize>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<TotalPage>3</TotalPage>\\n<TotalResults>45</TotalResults>\\n<PageNo>1</PageNo>\\n<Data>\\n <MemberName>匿名会员</MemberName>\\n <CarbonCopy>234432</CarbonCopy>\\n <CreateTime>1614824872</CreateTime>\\n <ServiceId>555555</ServiceId>\\n <TicketId>2500000010</TicketId>\\n <Priority>1</Priority>\\n <CreatorId>555555</CreatorId>\\n <FormData>{\\"questionInfo\\":\\"自动化创建工单\\"}</FormData>\\n <FromInfo>hotline</FromInfo>\\n <ModifiedTime>1614824872</ModifiedTime>\\n <TaskStatus>处理中</TaskStatus>\\n <CreatorName>刘测试</CreatorName>\\n <CategoryId>10000</CategoryId>\\n <CreatorType>4</CreatorType>\\n <MemberId>1876543</MemberId>\\n <CaseStatus>6</CaseStatus>\\n <TemplateId>546754</TemplateId>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'AssignTicket' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2500000010', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '666666', + ], + ], + [ + 'name' => 'AcceptorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '234432', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'CloseTicket' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2500000010', + ], + ], + [ + 'name' => 'ActionItems', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '555555', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ExecuteActivity' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '2500000010', + ], + ], + [ + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '555555', + ], + ], + [ + 'name' => 'ActivityCode', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'finish', + ], + ], + [ + 'name' => 'ActivityForm', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'AnswerCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'AppMessagePush' => [ + 'summary' => 'app提交', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => '实例ID', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-ss001', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户编号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP状态', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10', + 'minimum' => '-1', + 'example' => '1', + ], + ], + [ + 'name' => 'ExpirationTime', + 'in' => 'query', + 'schema' => [ + 'title' => '过期时间', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'exclusiveMaximum' => true, + 'minimum' => '-9223372036854775808', + 'exclusiveMinimum' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '123-123143-4', + ], + 'Data' => [ + 'title' => '返回数据', + 'description' => '', + 'type' => 'string', + 'example' => 'null', + ], + 'Code' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'SysytemError', + ], + 'Success' => [ + 'title' => '通信码', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + 503 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'System Error', + ], + ], + 600 => [ + [ + 'errorCode' => 'InvalidParam', + 'errorMessage' => 'Invalid param', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"123-123143-4\\",\\n \\"Data\\": \\"null\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SysytemError\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RequestId>123-123143-4</RequestId>\\n<Data>null</Data>\\n<Code>200</Code>\\n<Message>SysytemError</Message>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ChangeChatAgentStatus' => [ + 'summary' => '修改在线客服状态', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => 'clientToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '示例id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '账户名称', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Method', + 'in' => 'formData', + 'schema' => [ + 'title' => '修改到的状态类型', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'requestLogout', + 'enum' => [ + 'requestRest', + 'requestLogout', + 'restToWork', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'HttpStatusCode' => [ + 'title' => 'httpStatusCode', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => 'data', + 'description' => 'data', + 'type' => 'string', + 'example' => '0', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'Agent.NotFound', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Agent.NotFound\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ChangeChatAgentStatusResponse>\\n <Message>xxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>0</Data>\\n <Code>Agent.NotFound</Code>\\n <Success>true</Success>\\n</ChangeChatAgentStatusResponse>","errorExample":""}]', + ], + 'CreateCustomer' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProdLineId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '10552599', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'BizType', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'xp_commerce_aliyun', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TypeCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1360000xxxx', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'ManagerName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Contacter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Dingding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123yiyo', + ], + ], + [ + 'name' => 'OuterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10000011', + ], + ], + [ + 'name' => 'OuterIdType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '{"CustomerId":"24027"}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"创建成功\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>创建成功</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'CreateEntityIvrRoute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityBizCodeType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateSkillGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'SkillGroupName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '7', + 'minimum' => '0', + 'example' => '2', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'Message', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => 'RequestId', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Code' => [ + 'description' => 'Code', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => 'Success', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>123456</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'CreateSubTicket' => [ + 'summary' => '创建工单', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'CreatorName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'FromInfo', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'FormData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + [ + 'name' => 'MemberName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'ParentCaseId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'BizData', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'CreateThirdSsoAgent' => [ + 'summary' => '创建坐席并开通sso登录能力', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => 'clientToken', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'param1', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre***', + ], + ], + [ + 'name' => 'ClientId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'param2', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'AccountId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'param3', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'accountId1', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'param4', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'accountName1', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'param5', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SkillGroupIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => 'param6', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + [ + 'name' => 'RoleIds', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'title' => 'param7', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'HttpStatusCode' => [ + 'title' => 'httpStatusCode', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Data' => [ + 'title' => '新创建的坐席id', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateThirdSsoAgentResponse>\\n <Message>xxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>123456</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</CreateThirdSsoAgentResponse>","errorExample":""}]', + ], + 'createTicketWithBizData' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '30401', + ], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '397001', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '555555', + ], + ], + [ + 'name' => 'CreatorType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '4', + ], + ], + [ + 'name' => 'CreatorName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '-1', + ], + ], + [ + 'name' => 'MemberName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'FromInfo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'manual', + ], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '10', + 'minimum' => '0', + 'example' => '3', + ], + ], + [ + 'name' => 'CarbonCopy', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '234432', + ], + ], + [ + 'name' => 'FormData', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'BizData', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2500000010', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2500000010,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>2500000010</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'DeleteEntityRoute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UniqueId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'EditEntityRoute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityBizCodeType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'UniqueId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'FetchCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GenerateWebSocketSign' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>dnthF_oinHg7JMJDmKqex3UxDD7</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetAuthInfo' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'type' => 'string', + ], + 'Time' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AppKey' => [ + 'type' => 'string', + ], + 'App' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'SessionId' => [ + 'type' => 'string', + ], + 'UserName' => [ + 'type' => 'string', + ], + 'TenantId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 201 => [ + [ + 'errorCode' => 'GetAuthInfoFailed', + 'errorMessage' => 'Failed to get authorization information.', + ], + ], + [ + [ + 'errorCode' => 'GetTenantIdFailed', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetByForeignId' => [ + 'summary' => '获取外部账号映射的会员账号关系信息', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetCallsPerDay' => [ + 'summary' => '获取日来电次数', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'DataIdStart', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '20210316', + ], + ], + [ + 'name' => 'DataIdEnd', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '20210316', + ], + ], + [ + 'name' => 'DataId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'HourId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'MinuteId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Y', + ], + ], + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1583709xxxx', + ], + ], + [ + 'name' => 'HavePhoneNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1583709xxxx', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'phoneNum and havePhoneNum must be either empty or not empty at the same time', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '45FAB8AB-CFB3-4582-B1A5-9010DEADD8F9', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'InvalidPhone', + ], + 'Success' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '13', + ], + 'PageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageNo' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'CallsPerdayResponseList' => [ + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => 'object', + 'type' => 'object', + 'properties' => [ + 'DataId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + 'HourId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + 'TenantId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0', + ], + 'TenantName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '50', + ], + 'PhoneNum' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1583709xxxx', + ], + 'CallOutCnt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'CallInCnt' => [ + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'MinuteId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'GetTenantIdFailed', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + 400 => [ + [ + 'errorCode' => 'DataIdEndError', + 'errorMessage' => 'dataIdStart must be a time stamp and cannot be empty.', + ], + [ + 'errorCode' => 'DataIdStartError', + 'errorMessage' => 'dataIdEnd must be a time stamp and cannot be empty.', + ], + [ + 'errorCode' => 'InvalidPhone', + 'errorMessage' => 'phoneNum and havePhoneNum must be either empty or not empty at the same time.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InstanceIdCannotBeNull', + 'errorMessage' => 'You must specify InstanceId.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"phoneNum and havePhoneNum must be either empty or not empty at the same time\\",\\n \\"RequestId\\": \\"45FAB8AB-CFB3-4582-B1A5-9010DEADD8F9\\",\\n \\"Code\\": \\"InvalidPhone\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 13,\\n \\"PageSize\\": 10,\\n \\"PageNo\\": \\"1\\",\\n \\"CallsPerdayResponseList\\": [\\n {\\n \\"DataId\\": \\"-1\\",\\n \\"HourId\\": \\"-1\\",\\n \\"TenantId\\": \\"0\\",\\n \\"TenantName\\": \\"50\\",\\n \\"PhoneNum\\": \\"1583709xxxx\\",\\n \\"CallOutCnt\\": \\"1\\",\\n \\"CallInCnt\\": \\"1\\",\\n \\"MinuteId\\": \\"-1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<Message>phoneNum and havePhoneNum must be either empty or not empty at the same time</Message>\\n<RequestId>45FAB8AB-CFB3-4582-B1A5-9010DEADD8F9</RequestId>\\n<Code>InvalidPhone</Code>\\n<Success>true</Success>\\n<Data>\\n <TotalNum>13</TotalNum>\\n <PageSize>10</PageSize>\\n <PageNo>1</PageNo>\\n <CallsPerdayResponseList>\\n <DataId>-1</DataId>\\n <HourId>-1</HourId>\\n <TenantId>0</TenantId>\\n <TenantName>50</TenantName>\\n <PhoneNum>1583709xxxx</PhoneNum>\\n <CallOutCnt>1</CallOutCnt>\\n <CallInCnt>1</CallInCnt>\\n <MinuteId>-1</MinuteId>\\n </CallsPerdayResponseList>\\n</Data>","errorExample":""}]', + ], + 'GetCMSIdByForeignId' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'Nick', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zhangsan', + ], + ], + [ + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE339D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CustomerTypeId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Avatar' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Gender' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'male', + ], + 'ForeignId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'UserId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'zhangsan', + ], + 'Nick' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Anonymity' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Phone' => [ + 'description' => '', + 'type' => 'string', + 'example' => '131111111111', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"CustomerTypeId\\": 1,\\n \\"Avatar\\": \\"xxxx\\",\\n \\"Gender\\": \\"male\\",\\n \\"ForeignId\\": \\"zhangsan\\",\\n \\"UserId\\": \\"zhangsan\\",\\n \\"Nick\\": \\"张三\\",\\n \\"Anonymity\\": false,\\n \\"Phone\\": \\"131111111111\\"\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <Status>1</Status>\\n <CustomerTypeId>1</CustomerTypeId>\\n <Avatar>xxxx</Avatar>\\n <Gender>male</Gender>\\n <ForeignId>zhangsan</ForeignId>\\n <UserId>zhangsan</UserId>\\n <Nick>张三</Nick>\\n <Anonymity>false</Anonymity>\\n <Phone>131111111111</Phone>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetEntityRoute' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + ], + ], + [ + 'name' => 'UniqueId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'EntityBizCodeType' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EntityId' => [ + 'type' => 'string', + ], + 'ServiceId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EntityBizCode' => [ + 'type' => 'string', + ], + 'DepartmentId' => [ + 'type' => 'string', + ], + 'UniqueId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EntityName' => [ + 'type' => 'string', + ], + 'ExtInfo' => [ + 'type' => 'string', + ], + 'EntityRelationNumber' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetEntityRouteList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'default' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageNo' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Total' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EntityRouteList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EntityBizCodeType' => [ + 'type' => 'string', + ], + 'GroupId' => [ + 'type' => 'string', + ], + 'EntityId' => [ + 'type' => 'string', + ], + 'ServiceId' => [ + 'type' => 'string', + ], + 'DepartmentId' => [ + 'type' => 'string', + ], + 'EntityBizCode' => [ + 'type' => 'string', + ], + 'UniqueId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EntityName' => [ + 'type' => 'string', + ], + 'ExtInfo' => [ + 'type' => 'string', + ], + 'EntityRelationNumber' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetEntityTagRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'maxLength' => 9.223372036854776E+18, + 'minLength' => -1, + 'default' => '20', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'maxLength' => 9.223372036854776E+18, + 'minLength' => -1, + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => [ + 'type' => 'string', + ], + 'TagGroupCode' => [ + 'type' => 'string', + ], + 'EntityId' => [ + 'type' => 'string', + ], + 'TagCode' => [ + 'type' => 'string', + ], + 'EntityType' => [ + 'type' => 'string', + ], + 'TagGroupName' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetGrantedRoleIds' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '{555555,777777}', + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n 0\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetNumLocation' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '136098792', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>杭州</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetOutbounNumList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'NumGroup' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Jella', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '76', + ], + ], + ], + ], + 'Num' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Value' => [ + 'description' => '', + 'type' => 'string', + 'example' => '9065446', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"NumGroup\\": [\\n {\\n \\"Type\\": 2,\\n \\"Value\\": \\"Jella\\",\\n \\"Description\\": \\"76\\"\\n }\\n ],\\n \\"Num\\": [\\n {\\n \\"Type\\": 1,\\n \\"Value\\": \\"9065446\\",\\n \\"Description\\": \\"浙江省杭州市\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <NumGroup>\\n <Type>2</Type>\\n <Value>Jella</Value>\\n <Description>76</Description>\\n </NumGroup>\\n <Num>\\n <Type>1</Type>\\n <Value>9065446</Value>\\n <Description>浙江省杭州市</Description>\\n </Num>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetTagList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'maxLength' => 9.223372036854776E+18, + 'minLength' => -1, + 'default' => '20', + ], + ], + [ + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'maxLength' => 9.223372036854776E+18, + 'minLength' => -1, + 'default' => '1', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ScenarioCode' => [ + 'type' => 'string', + ], + 'TagGroupCode' => [ + 'type' => 'string', + ], + 'TagGroupName' => [ + 'type' => 'string', + ], + 'TagValues' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'string', + ], + 'Description' => [ + 'type' => 'string', + ], + 'TagName' => [ + 'type' => 'string', + ], + 'TagGroupCode' => [ + 'type' => 'string', + ], + 'TagCode' => [ + 'type' => 'string', + ], + 'TagGroupName' => [ + 'type' => 'string', + ], + 'EntityRelationNumber' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'GetTicketByCaseId' => [ + 'summary' => '查询工单信息-DB', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'MemberId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'QuestionId' => [ + 'type' => 'string', + ], + 'QuestionInfo' => [ + 'type' => 'string', + ], + 'MemberName' => [ + 'type' => 'string', + ], + 'SopCateId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ExtAttrs' => [ + 'type' => 'object', + ], + 'BuId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'EndTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'SrType' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Owner' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'OwnerName' => [ + 'type' => 'string', + ], + 'CaseStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ChannelId' => [ + 'type' => 'string', + ], + 'DepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FromInfo' => [ + 'type' => 'string', + ], + 'ParentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'GetTicketTemplateSchema' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '2147483648', + 'minimum' => '0', + 'example' => '546754', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'InvalidOperation', + 'errorMessage' => 'The operation is invalid.', + ], + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"buId\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"租户编码\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"string\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"sopCateId\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"业务类目\\\\\\\\\\\\\\"}\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>{\\\\\\"buId\\\\\\":{\\\\\\"title\\\\\\":\\\\\\"租户编码\\\\\\",\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"},\\\\\\"sopCateId\\\\\\":{\\\\\\"title\\\\\\":\\\\\\"业务类目\\\\\\"}</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GetUserToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => [ + 'title' => '用户id', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '875436', + ], + ], + [ + 'name' => 'Nick', + 'in' => 'formData', + 'schema' => [ + 'title' => '昵称', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'AppKey', + 'in' => 'formData', + 'schema' => [ + 'title' => 'appKey', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '54678765', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => '错误信息', + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'title' => '鹰眼id', + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-xxxx', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Expires' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1614528000000', + ], + 'Token' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxx-xxx-xxxx', + ], + ], + ], + 'Code' => [ + 'title' => '错误码', + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'title' => '是否调用成功', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'AppInvalid', + 'errorMessage' => 'The APPKEY is invalid.', + ], + [ + 'errorCode' => 'UserIdNotNull', + 'errorMessage' => 'UserId cannot be null.', + ], + [ + 'errorCode' => 'InvalidForeignId', + 'errorMessage' => 'The ForeignId is invalid.', + ], + ], + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-xxxx\\",\\n \\"Data\\": {\\n \\"Expires\\": 1614528000000,\\n \\"Token\\": \\"xxx-xxx-xxxx\\"\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-xxxx</RequestId>\\n<Data>\\n <Expires>1614528000000</Expires>\\n <Token>xxx-xxx-xxxx</Token>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'GrantRoles' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => true, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'HangupCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'HangupThirdCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'HoldCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'JoinThirdCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719786', + ], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719787', + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '7719788', + ], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ListSkillGroup' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '7', + 'minimum' => '0', + 'example' => '2', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ChannelType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SkillGroupId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + 'Name' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"Description\\": \\"自动化技能组\\",\\n \\"ChannelType\\": 2,\\n \\"SkillGroupId\\": 123456,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>2</ChannelType>\\n <SkillGroupId>123456</SkillGroupId>\\n <Name>自动化技能组</Name>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QueryRelationTickets' => [ + 'summary' => '查询相关工单', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'CaseType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'SrType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'TouchId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'DealId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'style' => 'flat', + 'schema' => [ + 'type' => 'object', + ], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'StartCaseGmtCreate', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'EndCaseGmtCreate', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'CurrentPage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CnePageSize' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'FirstResult' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalResults' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalPage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'NextPage' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseGmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GaseGmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'SrType' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Owner' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ChannelId' => [ + 'type' => 'string', + ], + 'MemberId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ExtAttrs' => [ + 'type' => 'object', + ], + 'ChannelType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'QuestionInfo' => [ + 'type' => 'string', + ], + 'QuestionId' => [ + 'type' => 'string', + ], + 'OwnerName' => [ + 'type' => 'string', + ], + 'MemberName' => [ + 'type' => 'string', + ], + 'RefCaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseDepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseBuId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FormId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreatorId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DealId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Title' => [ + 'type' => 'string', + ], + 'DealTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DeadLine' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AssignTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'UserServiceId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'BuId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TemplateId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FromInfo' => [ + 'type' => 'string', + ], + 'ServiceType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ParentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'RelationCase' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseGmtCreate' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseGmtModified' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Owner' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ChannelId' => [ + 'type' => 'string', + ], + 'MemberId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'ExtAttrs' => [ + 'type' => 'object', + ], + 'ChannelType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'QuestionInfoQuestionInfo' => [ + 'type' => 'string', + ], + 'QuestionId' => [ + 'type' => 'string', + ], + 'OwnerName' => [ + 'type' => 'string', + ], + 'MemberName' => [ + 'type' => 'string', + ], + 'RefCaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseDepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseBuId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FormId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CreatorId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DealId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Priority' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Title' => [ + 'type' => 'string', + ], + 'DealTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DeadLine' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AssignTime' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'UserServiceId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'GroupName' => [ + 'type' => 'string', + ], + 'BuId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'DepartmentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TemplateId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'FromInfo' => [ + 'type' => 'string', + ], + 'ServiceType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'ParentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'CaseId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'TaskId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => null, + ], + 'QueryRingDetailList' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '20', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1', + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1614824872', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '1614824972', + ], + ], + [ + 'name' => 'CallOutStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"isCallBack\\":\\"true\\"}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'FromPhoneNumList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + ], + ], + [ + 'name' => 'ToPhoneNumList', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"buId": 0,"gmtModified": "2021-03-08T11:10Z","lstVisitCnt": 3,"fromPhoneNum": "130196","gmtCreate": "2021-03-08T09:52Z","uniqueBizId": "13019651928","toPhoneNum": "057126","dateId": "20210308","lstVisitTime": "2021-03-08 10:17:48", "id":555555 , "callOutStatus": "4" }', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"buId\\\\\\": 0,\\\\\\"gmtModified\\\\\\": \\\\\\"2021-03-08T11:10Z\\\\\\",\\\\\\"lstVisitCnt\\\\\\": 3,\\\\\\"fromPhoneNum\\\\\\": \\\\\\"130196\\\\\\",\\\\\\"gmtCreate\\\\\\": \\\\\\"2021-03-08T09:52Z\\\\\\",\\\\\\"uniqueBizId\\\\\\": \\\\\\"13019651928\\\\\\",\\\\\\"toPhoneNum\\\\\\": \\\\\\"057126\\\\\\",\\\\\\"dateId\\\\\\": \\\\\\"20210308\\\\\\",\\\\\\"lstVisitTime\\\\\\": \\\\\\"2021-03-08 10:17:48\\\\\\", \\\\\\"id\\\\\\":555555 , \\\\\\"callOutStatus\\\\\\": \\\\\\"4\\\\\\" }\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>{\\"buId\\": 0,\\"gmtModified\\": \\"2021-03-08T11:10Z\\",\\"lstVisitCnt\\": 3,\\"fromPhoneNum\\": \\"130196\\",\\"gmtCreate\\": \\"2021-03-08T09:52Z\\",\\"uniqueBizId\\": \\"13019651928\\",\\"toPhoneNum\\": \\"057126\\",\\"dateId\\": \\"20210308\\",\\"lstVisitTime\\": \\"2021-03-08 10:17:48\\", \\"id\\":555555 , \\"callOutStatus\\": \\"4\\" }</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QueryServiceConfig' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'ViewCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'serviceContextViewChatStand', + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{"memberId":64007246863,"channelType":2,"channelId":"3a184074ee34426795f3986d306b2689"},"sdkInstance":"9JKPvcl8xaN2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 202 => [ + [ + 'errorCode' => 'GetTenantIdFailed', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + [ + [ + 'errorCode' => 'callRnderFailed', + 'errorMessage' => 'Failed to call the viewRenderService.Render operation.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InstanceIdCannotBeNull', + 'errorMessage' => 'You must specify InstanceId.', + ], + [ + 'errorCode' => 'ViewCodeNotNull', + 'errorMessage' => 'You must specify ViewCode.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"binds\\\\\\": {\\\\\\"hk9xtvX6usP2\\\\\\": {\\\\\\"ref\\\\\\": {\\\\\\"fieldCode\\\\\\": \\\\\\"historyCntOf7\\\\\\",\\\\\\"label\\\\\\": \\\\\\"7天内服务次数\\\\\\",\\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\\\"boCode\\\\\\": \\\\\\"serviceContextObj\\\\\\"},\\\\\\"jPath\\\\\\": \\\\\\"children\\\\\\",\\\\\\"source\\\\\\": \\\\\\"data\\\\\\"},\\\\\\"hYUi5kwGf0Pm\\\\\\": {\\\\\\"ref\\\\\\": {\\\\\\"fieldCode\\\\\\": \\\\\\"groupName\\\\\\",\\\\\\"label\\\\\\": \\\\\\"进线技能组\\\\\\",\\\\\\"type\\\\\\": \\\\\\"object\\\\\\",\\\\\\"boCode\\\\\\": \\\\\\"serviceContextObj\\\\\\"},\\\\\\"jPath\\\\\\": \\\\\\"children\\\\\\",\\\\\\"source\\\\\\": \\\\\\"data\\\\\\"}\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>{\\"binds\\": {\\"hk9xtvX6usP2\\": {\\"ref\\": {\\"fieldCode\\": \\"historyCntOf7\\",\\"label\\": \\"7天内服务次数\\",\\"type\\": \\"object\\",\\"boCode\\": \\"serviceContextObj\\"},\\"jPath\\": \\"children\\",\\"source\\": \\"data\\"},\\"hYUi5kwGf0Pm\\": {\\"ref\\": {\\"fieldCode\\": \\"groupName\\",\\"label\\": \\"进线技能组\\",\\"type\\": \\"object\\",\\"boCode\\": \\"serviceContextObj\\"},\\"jPath\\": \\"children\\",\\"source\\": \\"data\\"}</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'QuerySkillGroups' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1000', + 'minimum' => '1', + 'example' => '20', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '2', + ], + ], + [ + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'maximum' => '9223372036854775807', + 'minimum' => '-1', + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'OnePageSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'CurrentPage' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'TotalResults' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '76', + ], + 'Data' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Description' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'ChannelType' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SkillGroupName' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'SkillGroupId' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123456', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OnePageSize\\": 20,\\n \\"TotalPage\\": 4,\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 76,\\n \\"Data\\": [\\n {\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"Description\\": \\"自动化技能组\\",\\n \\"ChannelType\\": 2,\\n \\"SkillGroupName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<OnePageSize>20</OnePageSize>\\n<TotalPage>4</TotalPage>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<CurrentPage>1</CurrentPage>\\n<TotalResults>76</TotalResults>\\n<Data>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>2</ChannelType>\\n <SkillGroupName>自动化技能组</SkillGroupName>\\n <SkillGroupId>123456</SkillGroupId>\\n</Data>","errorExample":""}]', + ], + 'RemoveSkillGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'SendOutboundCommand' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CallingNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'default' => '-1', + ], + ], + [ + 'name' => 'CalledNumber', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CustomerInfo', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'StartCall' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Caller', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9065446', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '136098792', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'StartCallV2' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Caller', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9065446', + ], + ], + [ + 'name' => 'Callee', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '136098792', + ], + ], + [ + 'name' => 'JsonMsg', + 'in' => 'formData', + 'schema' => [ + 'description' => 'JsonMsg', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'StartChatWork' => [ + 'summary' => '修改在线客服为上班状态', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'instanceId', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'ccc_xspace***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => 'accountName', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => 'account1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'description' => '', + 'type' => 'string', + 'example' => 'xxx', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-xxxx', + ], + 'HttpStatusCode' => [ + 'title' => 'httpStatusCode', + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => 'data', + 'description' => '', + 'type' => 'string', + 'example' => '1', + ], + 'Code' => [ + 'title' => 'code', + 'description' => '', + 'type' => 'string', + 'example' => 'Agent.NotFound', + ], + 'Success' => [ + 'title' => 'success', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'IdempotentParameterMismatch', + 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-xxxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"Agent.NotFound\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartChatWorkResponse>\\n <Message>xxx</Message>\\n <RequestId>EE338D98-9BD3-4413-xxxx</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>1</Data>\\n <Code>Agent.NotFound</Code>\\n <Success>true</Success>\\n</StartChatWorkResponse>","errorExample":""}]', + ], + 'UpdateCustomer' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProdLineId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '10552599', + ], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'BizType', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'xp_commerce_aliyun', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TypeCode', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1560000xxxx', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'ManagerName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Contacter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Dingding', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123yiyo', + ], + ], + [ + 'name' => 'OuterId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '10000011', + ], + ], + [ + 'name' => 'OuterIdType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '24027', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '{"CustomerId":"24027"}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'UpdateEntityTagRelation' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'EntityTagParam', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + 'maxLength' => 9.223372036854776E+18, + 'minLength' => -1, + 'default' => '20', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InvalidParameter', + 'errorMessage' => 'The specified parameter is invalid.', + ], + ], + ], + 'responseDemo' => null, + ], + 'UpdateRingStatus' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'UniqueBizId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '78604', + ], + ], + [ + 'name' => 'CallOutStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"isCallBack\\":\\"true\\"}', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '{"BizId": "78604"}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"BizId\\\\\\": \\\\\\"78604\\\\\\"}\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>{\\"BizId\\": \\"78604\\"}</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'UpdateRole' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + ], + ], + [ + 'name' => 'RoleName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'PermissionId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'required' => false, + 'maxItems' => 200, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'type' => 'string', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + 'responseDemo' => null, + ], + 'UpdateSkillGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '1', + 'example' => '123456', + ], + ], + [ + 'name' => 'SkillGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => [ + 'title' => '渠道类型', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'Success', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'InvalidInstanceId', + 'errorMessage' => 'The specified instance is unavailable or does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ], + 'ListAllHotLineSkillGroups' => [ + 'summary' => '查询某个租户下所有热线类型技能组及技能组分类', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepGroup' => [ + 'type' => 'object', + 'properties' => [ + 'DepGroupName' => [ + 'type' => 'string', + ], + 'DepGroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'SkillGroupAgents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillGroup' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => [ + 'type' => 'string', + ], + 'SkillGroupId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'Agents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountName' => [ + 'type' => 'string', + ], + 'DisplayName' => [ + 'type' => 'string', + ], + 'AgentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Status' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Acid' => [ + 'type' => 'string', + ], + 'JobId' => [ + 'type' => 'string', + ], + 'ConnId' => [ + 'type' => 'string', + ], + 'CustomerPhone' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + ], + ], + ], + 'AnwserAgentMonitor' => [ + 'summary' => '接通坐席监听', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CallerParentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerParentId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'title' => 'requestId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerType', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'StsTokenCallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'stsTokenCallerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'InstanceId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'title' => 'AccountName', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CallId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => 'JobId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionId', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'type' => 'string', + ], + 'Code' => [ + 'title' => 'code', + 'type' => 'string', + ], + 'Success' => [ + 'title' => 'success', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'GetForeignIdByCMSId' => [ + 'summary' => '通过CMSId获取ForeignId', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => true, + ], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'CustomerTypeId' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'Avatar' => [ + 'type' => 'string', + ], + 'Gender' => [ + 'type' => 'string', + ], + 'ForeignId' => [ + 'type' => 'string', + ], + 'UserId' => [ + 'type' => 'string', + ], + 'Nick' => [ + 'type' => 'string', + ], + 'Anonymity' => [ + 'type' => 'boolean', + ], + 'Phone' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + ], + ], + 'HangUpAgentMonitor' => [ + 'summary' => '挂断坐席监听', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CallerParentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerParentId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'title' => 'requestId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerType', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'StsTokenCallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'stsTokenCallerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'InstanceId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'title' => 'AccountName', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'title' => 'CallId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => 'JobId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ConnectionId', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'type' => 'string', + ], + 'Code' => [ + 'title' => 'code', + 'type' => 'string', + ], + 'Success' => [ + 'title' => 'success', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'StartAgentMonitor' => [ + 'summary' => '发起坐席监听', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CallerParentId', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerParentId', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => [ + 'title' => 'requestId', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'title' => 'clientToken', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerType', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'callerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'StsTokenCallerUid', + 'in' => 'query', + 'schema' => [ + 'title' => 'stsTokenCallerUid', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'param1', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'title' => 'param2', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => [ + 'title' => 'param4', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => [ + 'title' => 'param5', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'param6', + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'title' => 'message', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => 'requestId', + 'type' => 'string', + ], + 'Code' => [ + 'title' => 'code', + 'type' => 'string', + ], + 'Success' => [ + 'title' => 'success', + 'type' => 'boolean', + ], + ], + ], + ], + ], + ], + 'BindAgentHotlinePhone' => [ + 'summary' => '绑定热线坐席手机号', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '136********', + ], + ], + [ + 'name' => 'VerifyCode', + 'in' => 'formData', + 'schema' => [ + 'title' => '验证码', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '123456', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Void>', + 'description' => 'Result<Void>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NoTenantFound', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"<BindAgentHotlinePhoneResponse>\\n <Success>true</Success>\\n <Code>NoTenantFound</Code>\\n <Message>xxxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</BindAgentHotlinePhoneResponse>","errorExample":""}]', + ], + 'GetHotlineAgentDetailWithChannel' => [ + 'summary' => '同 GetHotlineAgentDetail,返回上班渠道', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'AgentStatusCode' => [ + 'type' => 'string', + ], + 'Token' => [ + 'type' => 'string', + ], + 'AgentId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'Assigned' => [ + 'type' => 'boolean', + ], + 'RestType' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AgentStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'TenantId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'WorkChannel' => [ + 'title' => '上班渠道,PC电脑上班,PSTN手机上班', + 'type' => 'string', + ], + 'ExtAttr' => [ + 'title' => '扩展字段', + 'type' => 'string', + ], + ], + ], + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + ], + 'GetAgentHotlinePhone' => [ + 'summary' => '查询坐席绑定手机号', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<String>', + 'description' => 'Result<String>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NoTenantFound', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Data' => [ + 'title' => '手机号', + 'description' => '', + 'type' => 'string', + 'example' => '136********', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"136********\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentHotlinePhoneResponse>\\n <Success>true</Success>\\n <Code>NoTenantFound</Code>\\n <Message>xxxx</Message>\\n <Data>136********</Data>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</GetAgentHotlinePhoneResponse>","errorExample":""}]', + ], + 'GetAgentHotline' => [ + 'summary' => '查询热线坐席信息与热线技能组', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'type' => 'string', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Agent>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AgentId' => [ + 'title' => '小二ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AccountName' => [ + 'title' => '坐席账号名称(坐席登录名)', + 'type' => 'string', + ], + 'DisplayName' => [ + 'title' => 'XP账号对外展示名称', + 'type' => 'string', + ], + 'GroupList' => [ + 'title' => '热线技能组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillGroupId' => [ + 'title' => '技能组ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'Name' => [ + 'title' => '技能组名称', + 'type' => 'string', + ], + 'DisplayName' => [ + 'title' => '技能组对外显示名', + 'type' => 'string', + ], + ], + ], + ], + 'DepartmentId' => [ + 'title' => '部门ID', + 'type' => 'string', + ], + 'AgentPhone' => [ + 'title' => '坐席绑定手机号', + 'type' => 'string', + ], + 'SkillGroups' => [ + 'title' => '热线技能组,格式:"[123,456,......,789]"', + 'type' => 'string', + ], + 'ExtAttr' => [ + 'title' => '扩展字段', + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + ], + 'UnbindAgentHotlinePhone' => [ + 'summary' => '解绑热线坐席手机号', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Void>', + 'description' => 'Result<Void>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NoTenantFound', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"<UnbindAgentHotlinePhoneResponse>\\n <Success>true</Success>\\n <Code>NoTenantFound</Code>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</UnbindAgentHotlinePhoneResponse>","errorExample":""}]', + ], + 'GetAgentWorkStatus' => [ + 'summary' => '查询热线坐席上班状态', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号的映射', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[email protected]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<AgentHotlineWorkStatus>', + 'description' => 'Result<AgentHotlineWorkStatus>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NoTenantFound', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxxx', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '905', + ], + 'AgentId' => [ + 'title' => '小二ID', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1059054', + ], + 'AccountName' => [ + 'title' => '坐席账号名称(坐席登录名)', + 'description' => '', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'AgentStatusCode' => [ + 'title' => '坐席上班状态code', + 'description' => '', + 'type' => 'string', + 'example' => 'AgentCheckin', + ], + 'AgentStatusDesc' => [ + 'title' => '坐席上班状态描述', + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'WorkChannel' => [ + 'title' => '上班渠道,PSTN手机上班,PC电脑上班', + 'description' => '', + 'type' => 'string', + 'example' => 'PC', + ], + 'ExtAttr' => [ + 'title' => '扩展字段', + 'description' => '', + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"TenantId\\": 905,\\n \\"AgentId\\": 1059054,\\n \\"AccountName\\": \\"[email protected]\\",\\n \\"AgentStatusCode\\": \\"AgentCheckin\\",\\n \\"AgentStatusDesc\\": \\"坐席签入状态\\",\\n \\"WorkChannel\\": \\"PC\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentWorkStatusResponse>\\n <Success>true</Success>\\n <Code>NoTenantFound</Code>\\n <Message>xxxxx</Message>\\n <Data>\\n <TenantId>905</TenantId>\\n <AgentId>1059054</AgentId>\\n <AccountName>[email protected]</AccountName>\\n <AgentStatusCode>AgentCheckin</AgentStatusCode>\\n <AgentStatusDesc>坐席签入状态</AgentStatusDesc>\\n <WorkChannel>PC</WorkChannel>\\n </Data>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</GetAgentWorkStatusResponse>","errorExample":""}]', + ], + 'SendVerificationCode' => [ + 'summary' => '短信验证码发送', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ccc_xp_pre-cn-***', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => [ + 'title' => '手机号(坐席绑定手机号码)', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '136********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<Void>', + 'description' => 'Result<Void>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'NoTenantFound', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'EE338D98-9BD3-4413-B165', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"<SendVerificationCodeResponse>\\n <Success>true</Success>\\n <Code>NoTenantFound</Code>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</SendVerificationCodeResponse>","errorExample":""}]', + ], + 'StartHotlineWork' => [ + 'summary' => '热线坐席上班', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户请求唯一id,用于幂等校验,可以用uuid生成', + 'type' => 'string', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => 'AICCS实例ID,在智能联络中心控制台上可以看到', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席账号名称(唯一值),外部账号与XP账号登录名的映射', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'WorkChannel', + 'in' => 'formData', + 'schema' => [ + 'title' => '上班渠道,枚举值:(手机上班)PSTN ; (PC上班)PC', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SkillGroups', + 'in' => 'formData', + 'schema' => [ + 'title' => '坐席热线技能组,格式:"[123,456,......,789]"', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Result<AgentHotlineWorkStatus>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TenantId' => [ + 'title' => '租户ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AgentId' => [ + 'title' => '小二ID', + 'type' => 'integer', + 'format' => 'int64', + ], + 'AccountName' => [ + 'title' => '坐席账号名称(坐席登录名)', + 'type' => 'string', + ], + 'AgentStatusCode' => [ + 'title' => '坐席上班状态code', + 'type' => 'string', + ], + 'AgentStatusDesc' => [ + 'title' => '坐席上班状态描述', + 'type' => 'string', + ], + 'WorkChannel' => [ + 'title' => '上班渠道,PSTN手机上班,PC电脑上班', + 'type' => 'string', + ], + 'AgentToken' => [ + 'title' => '前端token', + 'type' => 'string', + ], + 'ExtAttr' => [ + 'title' => '扩展字段', + 'type' => 'string', + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + ], + 'FinishHotlineServiceNew' => [ + 'summary' => '热线下班接口,参考FinishHotlineService,坐席通话中下班失败', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'boolean', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + [ + 'errorCode' => 'NoAgentFound', + 'errorMessage' => 'The specified agent does not exist.', + ], + ], + ], + ], + 'GetOnlineTouchSessionList' => [ + 'summary' => '查询在线会话记录信息列表【以touch为维度】', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => [ + 'title' => '实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '技能组id', + 'type' => 'array', + 'items' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'maxItems' => 10, + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => [ + 'title' => '开始时间【会话接通时间筛选范围】,格式:时间戳(毫秒)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => [ + 'title' => '结束时间【会话接通时间筛选范围】,格式:时间戳(毫秒)', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => [ + 'title' => '当前页', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'title' => '页数,默认10,最大值30', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'PageResult<OnlineSessionInfo>', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'boolean', + ], + 'Code' => [ + 'title' => '错误码', + 'type' => 'string', + ], + 'Message' => [ + 'title' => '错误信息', + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserForeignId' => [ + 'title' => '外部会员ID', + 'type' => 'string', + ], + 'SessionId' => [ + 'title' => '会话ID,消息记录对象MessageInfo实例的唯一编码,与接触编码TouchId为1对多关系', + 'type' => 'string', + ], + 'TouchId' => [ + 'title' => '接触编码,用户进线后,多次转交到不同人工,会生成多个接触编码', + 'type' => 'string', + ], + 'ChannelId' => [ + 'title' => '当次进线编码,同sid', + 'type' => 'string', + ], + 'GroupId' => [ + 'title' => '技能组ID', + 'type' => 'string', + ], + 'GroupName' => [ + 'title' => '技能组名称', + 'type' => 'string', + ], + 'FirstTime' => [ + 'title' => '会话接通时间,时间戳', + 'type' => 'integer', + 'format' => 'int64', + ], + 'MessageInfo' => [ + 'title' => '对话详情记录列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MessageId' => [ + 'title' => '消息序列号', + 'type' => 'integer', + 'format' => 'int64', + ], + 'SenderId' => [ + 'title' => '消息发送人ID', + 'type' => 'string', + ], + 'SenderName' => [ + 'title' => '消息发送人名称', + 'type' => 'string', + ], + 'SenderType' => [ + 'title' => '消息发送人,枚举值:1会员,2客服', + 'type' => 'string', + ], + 'Content' => [ + 'title' => '消息内容', + 'type' => 'string', + ], + 'GmtCreated' => [ + 'title' => '消息发送实际,格式:时间戳', + 'type' => 'string', + ], + 'Status' => [ + 'title' => '消息日志的状态,0默认,50撤回', + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'HttpStatusCode' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageNo' => [ + 'title' => '当前页', + 'type' => 'integer', + 'format' => 'int32', + ], + 'TotalResults' => [ + 'title' => '总记录数', + 'type' => 'integer', + 'format' => 'int32', + ], + 'PageSize' => [ + 'title' => '页数', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'NoTenantFound', + 'errorMessage' => 'The specified tenant does not exist.', + ], + [ + 'errorCode' => 'SystemError', + 'errorMessage' => 'A system error occurred. Please contact the administrator.', + ], + ], + ], + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'cn-shanghai', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wulanchabu', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-2', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-3', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'us-east-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'us-west-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'ap-south-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'me-east-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'scsp.aliyuncs.com', + ], + ], +]; |
