From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- data/en_us/scsp/2020-07-02/api-docs.php | 18684 ++++++++++-------------------- 1 file changed, 6287 insertions(+), 12397 deletions(-) (limited to 'data/en_us/scsp/2020-07-02/api-docs.php') diff --git a/data/en_us/scsp/2020-07-02/api-docs.php b/data/en_us/scsp/2020-07-02/api-docs.php index c2edef5..f51b19c 100644 --- a/data/en_us/scsp/2020-07-02/api-docs.php +++ b/data/en_us/scsp/2020-07-02/api-docs.php @@ -1,666 +1,383 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'scsp', - 'version' => '2020-07-02', - ], + 'info' => ['style' => 'RPC', 'product' => 'scsp', 'version' => '2020-07-02'], 'directories' => [ [ - 'id' => 102934, - 'title' => null, + 'children' => ['QueryHotlineDashboard'], 'type' => 'directory', - 'children' => [ - 'QueryHotlineDashboard', - ], + 'title' => 'Salary', ], [ - 'id' => 102936, - 'title' => null, + 'children' => ['QueryServicerById', 'QueryServicerByDepartmentAndMixName', 'CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'GetHotlineAgentDetail', 'ListAgentBySkillGroupId', 'ListOutboundPhoneNumber', 'GetHotlineWaitingNumber', 'TransferCallToAgent'], 'type' => 'directory', - 'children' => [ - 'QueryServicerById', - 'QueryServicerByDepartmentAndMixName', - 'CreateAgent', - 'DeleteAgent', - 'UpdateAgent', - 'GetAgent', - 'GetHotlineAgentDetail', - 'ListAgentBySkillGroupId', - 'ListOutboundPhoneNumber', - 'GetHotlineWaitingNumber', - 'TransferCallToAgent', - ], + 'title' => 'Agent', ], [ - 'id' => 102939, - 'title' => null, + 'children' => ['GetAllDepartment'], 'type' => 'directory', - 'children' => [ - 'GetAllDepartment', - ], + 'title' => 'Department', ], [ - 'id' => 102941, - 'title' => null, + 'children' => ['CreateOuterCallCenterData', 'StartHotlineService', 'ListHotlineRecord', 'QueryHotlineSession', 'GetHotlineAgentDetailReport', 'GetHotlineAgentStatus', 'GetHotlineGroupDetailReport', 'GetOuterCallCenterDataList', 'SendHotlineHeartBeat', 'SuspendHotlineService', 'TransferCallToPhone', 'TransferCallToSkillGroup', 'TransferToThirdCall', 'FinishHotlineService'], 'type' => 'directory', - 'children' => [ - 'CreateOuterCallCenterData', - 'StartHotlineService', - 'ListHotlineRecord', - 'QueryHotlineSession', - 'GetHotlineAgentDetailReport', - 'GetHotlineAgentStatus', - 'GetHotlineGroupDetailReport', - 'GetOuterCallCenterDataList', - 'SendHotlineHeartBeat', - 'SuspendHotlineService', - 'TransferCallToPhone', - 'TransferCallToSkillGroup', - 'TransferToThirdCall', - 'FinishHotlineService', - ], + 'title' => 'Hotline', ], [ - 'id' => 102966, - 'title' => null, + 'children' => ['CreateRole', 'DisableRole', 'EnableRole'], 'type' => 'directory', - 'children' => [ - 'CreateRole', - 'DisableRole', - 'EnableRole', - ], + 'title' => 'Role', ], [ - 'id' => 102970, - 'title' => null, + 'children' => ['CreateTicket', 'UpdateTicket', 'QueryTicketActions', 'QueryTicketCount', 'QueryTickets', 'SearchTicketById', 'SearchTicketByPhone', 'SearchTicketList', 'AssignTicket', 'CloseTicket', 'ExecuteActivity'], 'type' => 'directory', - 'children' => [ - 'CreateTicket', - 'UpdateTicket', - 'QueryTicketActions', - 'QueryTicketCount', - 'QueryTickets', - 'SearchTicketById', - 'SearchTicketByPhone', - 'SearchTicketList', - 'AssignTicket', - 'CloseTicket', - 'ExecuteActivity', - ], + 'title' => 'Ticket', ], [ - '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', + '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', ], + 'type' => 'directory', + 'title' => 'Other', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'QueryHotlineDashboard' => [ - 'summary' => '查询薪资面板', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AnswerCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ 'name' => 'InstanceId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket message after an incoming call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket message after an incoming call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket message after an incoming call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'A short description of struct', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_***', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Answer an incoming call', + 'summary' => 'Answers an incoming call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'AnwserAgentMonitor' => [ + 'summary' => 'Connect agent listener ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'StartDate', + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'CallerParentId', 'in' => 'query', - 'schema' => [ - 'title' => '开始时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1636473600000', - ], + 'schema' => ['title' => 'callerParentId ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'RequestId', 'in' => 'query', - 'schema' => [ - 'title' => 'j结束时间', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1636473600000', - ], + 'schema' => ['title' => 'requestId ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'DepartmentIdList', + 'name' => 'ClientToken', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '部门标识列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'required' => false, - ], + 'schema' => ['title' => 'clientToken ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'ServicerIdList', + 'name' => 'CallerType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '坐席标识列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'required' => false, - ], + 'schema' => ['title' => 'callerType ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'SortFieldList', + 'name' => 'CallerUid', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '排序字段集合', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - 'required' => false, - ], + 'schema' => ['title' => 'callerUid ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'CurrentPageNum', + 'name' => 'StsTokenCallerUid', 'in' => 'query', - 'schema' => [ - 'title' => '当前页码', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => 'stsTokenCallerUid ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => '页面大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['title' => 'InstanceId ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['title' => 'AccountName ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['title' => 'CallId ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => 'JobId ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => ['title' => 'ConnectionId ', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', + 'title' => 'result ', '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', - ], + 'Message' => ['title' => 'message ', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'requestId ', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['title' => 'code ', 'type' => 'string', 'description' => '', 'example' => ''], + 'Success' => ['title' => 'success ', 'type' => 'boolean', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], - '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":"\\n ccc_xp_pre-cn-***\\n true\\n 200\\n successful\\n \\n 100\\n \\n 20211101\\n 727272\\n 加油-小高\\n 加油-小高\\n 11212121\\n 加油组\\n 10\\n 9\\n 20\\n 12\\n \\n \\n 200\\n","errorExample":""}]', - 'title' => 'QueryHotlineDashboard', - ], - 'QueryServicerById' => [ - 'summary' => '根据坐席标识查询坐席详细信息', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:42:18.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnwserAgentMonitor'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + ], + 'AppMessagePush' => [ + 'summary' => 'Pushes ticket information to a customer when the customer app is offline but the customer service representative is on duty. The customer handles the push on their end.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-ss001'], ], [ - 'name' => 'ServicerId', + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The user ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The app status. Valid values:'."\n" + .'- 1: online'."\n" + .'- 2: offline.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '-1', 'example' => '1'], + ], + [ + 'name' => 'ExpirationTime', 'in' => 'query', 'schema' => [ - 'title' => '坐席标识', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, + 'title' => '', 'description' => 'The expiration time.', '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', + 'title' => '', + 'description' => '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', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '123-123143-4'], + 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'string', 'example' => 'null'], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'SysytemError'], + 'Success' => ['title' => '', 'description' => 'The communication code.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], - ], - 'QueryServicerByDepartmentAndMixName' => [ - 'summary' => '分页查询客服信息通过部门和关键字', - 'methods' => [ - 'post', + '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.', 'description' => ''], + ], + 503 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'System Error', 'description' => ''], + ], + 600 => [ + ['errorCode' => 'InvalidParam', 'errorMessage' => 'Invalid param', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"123-123143-4\\",\\n \\"Data\\": \\"null\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"SysytemError\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Push app messages', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppMessagePush'], + ], ], + 'ramActions' => [], + ], + 'AssignTicket' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ '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', - ], - ], + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'KeyWord', - 'in' => 'query', - 'schema' => [ - 'title' => '关键字', - 'type' => 'string', - ], + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => ['description' => 'The ticket ID (ticket number).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2500000010', 'title' => ''], ], [ - 'name' => 'CurrentPageNum', - 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the operator who assigns the ticket.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '666666', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'name' => 'AcceptorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the user to whom the ticket is assigned.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '234432', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'description' => 'result', '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', - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - ], - 'CreateAgent' => [ - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Assign a ticket', + 'summary' => 'Assigns a ticket based on the ticket ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'BindAgentHotlinePhone' => [ + 'summary' => 'Updates the extended phone number information of an agent.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -671,399 +388,223 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'title' => 'js sdk中自动生成的鉴权token', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['title' => '', 'description' => 'The unique client request ID used for idempotence checks. You can use a UUID.', '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-***', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID of the AICCS instance. You can find this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['title' => '', 'description' => 'The agent account name (unique value). This is the mapping between the external account and the XP account logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'Phone', 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'format' => 'int64', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136********'], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'VerifyCode', '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, - ], + 'schema' => ['title' => '', 'description' => 'The verification code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '', + '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', - ], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'NoTenantFound', 'title' => ''], + 'Message' => ['description' => 'The error description. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n666666\\nSuccess\\ntrue","errorExample":""}]', - ], - 'DeleteAgent' => [ - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","type":"json"}]', + 'title' => 'Bind an agent phone number', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'ChangeChatAgentStatus' => [ + 'summary' => 'Modifies the status of an online customer service representative.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', '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-***', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ 'name' => 'AccountName', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the agent account, which must be unique within the instance (logon name).', 'type' => 'string', 'required' => true, 'example' => '123@123.com'], + ], + [ + 'name' => 'Method', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'The target status type. Valid values:'."\n" + .' '."\n" + .'- requestRest: requests a short break.'."\n" + .'- requestLogout: requests to go offline.'."\n" + .'- restToWork: switches from a short break to working.', 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', + 'enum' => ['requestRest', 'requestLogout', 'restToWork'], + 'example' => 'requestLogout', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', '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', - ], + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'xxx'], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'data', 'type' => 'string', 'example' => '0'], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'Agent.NotFound'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'example' => '', ], ], ], '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.', - ], + 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.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'UpdateAgent' => [ - 'methods' => [ - 'put', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Agent.NotFound\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify online customer service representative status', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeChatAgentStatus'], + ], ], + 'ramActions' => [], + ], + 'CloseTicket' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'DisplayName', + 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2500000010', 'title' => ''], ], [ - 'name' => 'SkillGroupId', + 'name' => 'ActionItems', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The custom action record in JSON format. Example: {"reason":"Forcibly closed by the business system"}.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '{"reason":"业务系统强制关闭"}', 'title' => ''], ], [ - 'name' => 'SkillGroupIdList', + 'name' => 'OperatorId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The ID of the operator.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '555555', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'GetAgent' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Close a ticket', + 'summary' => 'Closes a ticket by ticket ID and adds a custom action record.', + 'changeSet' => [ + ['createdAt' => '2021-04-14T08:50:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateAgent' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1072,42 +613,58 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique client request ID, used for idempotence checks. You can use a UUID to generate this value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'], ], [ 'name' => 'InstanceId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID of the Artificial Intelligence Cloud Call Service instance. You can view this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the agent account. The name must be unique within the instance. This value is used as the logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the agent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '刘测试', 'title' => ''], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', + 'description' => 'The ID of the skill group to which the agent belongs.', + 'type' => 'array', + 'format' => 'int64', + 'items' => ['description' => 'The skill group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AccountName', - 'in' => 'query', + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', + 'description' => 'The list of skill group IDs to which the agent belongs.', + 'type' => 'array', + 'format' => 'int64', + 'items' => ['description' => 'The skill group list.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456，145678', 'title' => ''], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], @@ -1117,174 +674,117 @@ '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' => '123@123.com', - ], - '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '666666', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoSkillGroupSetFound', 'errorMessage' => 'The specified skill group set does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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\\": \\"123@123.com\\",\\n \\"TenantId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0,\\n \\"Message\\": \\"\\"\\n}","errorExample":""},{"type":"xml","example":"EE338D98-9BD3-4413-B165\\n\\n 0\\n 刘测试\\n 222222\\n \\n 自动化技能组\\n 自动化技能组\\n 1\\n 123456\\n 自动化技能组\\n \\n 123@123.com\\n 0\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'GetHotlineAgentDetail' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 666666,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Create an agent', + 'summary' => 'Creates an agent account in the Cloud Customer Service System and returns the agent ID.', + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateCustomer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ProdLineId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The product line ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '10552599', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'The business type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xp_commerce_aliyun', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '张三', 'title' => ''], + ], + [ + 'name' => 'TypeCode', + 'in' => 'query', + 'schema' => ['description' => 'The customer type.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '1360000xxxx', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can find this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'ManagerName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The name of the manager.', 'type' => 'string', 'required' => false, 'example' => '管理人', 'title' => ''], + ], + [ + 'name' => 'Contacter', + 'in' => 'query', + 'schema' => ['description' => 'The creator.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => ['description' => 'The industry.', 'type' => 'string', 'required' => false, 'example' => '服饰', 'title' => ''], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => ['description' => 'The position.', 'type' => 'string', 'required' => false, 'example' => '主管', 'title' => ''], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'Dingding', + 'in' => 'query', + 'schema' => ['description' => 'The DingTalk account.', 'type' => 'string', 'required' => false, 'example' => '123yiyo', 'title' => ''], + ], + [ + 'name' => 'OuterId', + 'in' => 'query', + 'schema' => ['description' => 'The external ID.', 'type' => 'string', 'required' => false, 'example' => '10000011', 'title' => ''], + ], + [ + 'name' => 'OuterIdType', + 'in' => 'query', + 'schema' => ['description' => 'The external type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -1293,290 +793,207 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => '创建成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The customer data.', 'type' => 'integer', 'format' => 'int64', 'example' => '{"CustomerId":"24027"}', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n AgentCheckout\\n dnthF_oinHg7JMJDmKqex3UxDD7\\n 555555\\n false\\n 1\\n 1\\n 0\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'ListAgentBySkillGroupId' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"创建成功\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a customer', + 'summary' => 'Creates a customer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateEntityIvrRoute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '666666', - ], + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', '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' => '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' => '123@123.com', - ], - 'TenantId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + [ + 'name' => 'EntityBizCodeType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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\\": \\"123@123.com\\",\\n \\"TenantId\\": 0\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n 0\\n 刘测试\\n 666666\\n 123@123.com\\n 0\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'ListOutboundPhoneNumber' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateOuterCallCenterData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The session ID of the robot.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a15ce370-1051-4040-9822', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'InterveneTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the call is connected. For inbound calls, this is the same as gmt_create. For outbound calls, this is the time when the user answers the call.', 'type' => 'string', 'required' => false, 'example' => '16085570', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'name' => 'CallType', + 'in' => 'formData', + 'schema' => ['description' => 'The call type. Valid values:'."\n" + .'1: inbound call'."\n" + .'2: outbound call.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'FromPhoneNum', + 'in' => 'formData', + 'schema' => ['description' => 'The phone number of the caller, such as the mobile phone number of the user, the seat number of the customer service representative, or the robot number.', 'type' => 'string', 'required' => false, 'example' => '135615', 'title' => ''], + ], + [ + 'name' => 'ToPhoneNum', + 'in' => 'formData', + 'schema' => ['description' => 'The phone number of the callee, such as the mobile phone number of the user, the seat number of the customer service representative, or the robot number.', 'type' => 'string', 'required' => false, 'example' => '0571773', 'title' => ''], + ], + [ + 'name' => 'EndReason', + 'in' => 'formData', + 'schema' => ['description' => 'The reason why the call is hung up. Valid values:'."\n" + .'1: The call ends because it is transferred to a human agent.'."\n" + .'2: The call ends during the robot phase without being transferred to a human agent.'."\n" + .'3: The user actively hangs up the call.'."\n" + .'4: The robot actively hangs up the call.'."\n" + .'5: The call is hung up due to a network exception.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'UserInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The user information from the upstream system, in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{\\"level\\":25,\\"name\\":\\"Lee\\"}', 'title' => ''], + ], + [ + 'name' => 'RecordUrl', + 'in' => 'formData', + 'schema' => ['description' => 'The URL of the recording file.', 'type' => 'string', 'required' => false, 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the document number, such as order.', 'type' => 'string', 'required' => false, 'example' => 'SHOP_ID', 'title' => ''], + ], + [ + 'name' => 'BizId', + 'in' => 'formData', + 'schema' => ['description' => 'The key document number, such as the order ID.', 'type' => 'string', 'required' => false, 'example' => '78604', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The business information from the upstream system in JSON format, such as robot instance information.', 'type' => 'string', 'required' => false, 'example' => '{\\"isCallBack\\":\\"true\\"}', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], ], 'responses' => [ @@ -1585,69 +1002,31 @@ '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n{9065446}\\nSuccess\\ntrue","errorExample":""}]', - ], - 'GetHotlineWaitingNumber' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Sync hotline data', + 'summary' => 'Synchronizes hotline data.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1656,233 +1035,125 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', + 'name' => 'RoleName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PermissionId', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', + 'maxItems' => 200, + 'description' => '', + 'title' => '', + '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' => '2', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n2\\nSuccess\\ntrue","errorExample":""}]', - ], - 'TransferCallToAgent' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 0,\\n \\"Data\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'SkillGroupName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The name of the skill group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '在线自动化技能组', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The description of the skill group.', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组', 'title' => ''], ], [ - 'name' => 'TargetAccountName', + 'name' => 'DisplayName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '345@123.com', - ], + 'schema' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'required' => false, 'example' => '在线自动化技能组', 'title' => ''], ], [ - 'name' => 'CallId', + 'name' => 'ChannelType', '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', - ], + 'schema' => ['description' => 'The type of the skill group. Valid values:'."\n" + .'1: hotline '."\n" + .'2: online '."\n" + .'4: ticket.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '7', 'minimum' => '0', 'example' => '2', 'title' => ''], ], [ - 'name' => 'IsSingleTransfer', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], ], 'responses' => [ @@ -1891,125 +1162,138 @@ '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', - ], + 'Message' => ['description' => 'Message', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'RequestId', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The ID of the skill group that is created.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Code' => ['description' => 'Code', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Success', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'GetAllDepartment' => [ - 'summary' => '获取指定租户下的部门列表', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a skill group', + 'summary' => 'Creates a skill group based on the skill group name and channel type. You can define the display name and description of the skill group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateSubTicket' => [ + 'summary' => 'Creates a ticket.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CreatorId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CreatorName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FromInfo', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'FormData', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MemberName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ParentCaseId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'BizData', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', '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', - ], + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], - ], - 'CreateOuterCallCenterData' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-09-22T15:19:30.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubTicket'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": 0\\n}","type":"json"}]', + 'title' => '', + ], + 'CreateThirdSsoAgent' => [ + 'summary' => 'Creates a third-party single sign-on (SSO) agent in the Cloud Customer Service System based on a user account.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2017,187 +1301,228 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SessionId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a15ce370-1051-4040-9822', - ], + 'schema' => ['title' => '', 'description' => 'The unique ID of the client request. Used for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'], ], [ - 'name' => 'InterveneTime', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '16085570', - ], + 'schema' => ['title' => '', 'description' => 'The instance ID. You can obtain this ID from the Chinese International Chinese Smart Service console.', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre***'], ], [ - 'name' => 'CallType', + 'name' => 'ClientId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The client ID issued to the tenant instance.', 'type' => 'string', 'required' => true, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'], ], [ - 'name' => 'FromPhoneNum', + 'name' => 'AccountId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '135615', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the account to be synchronized.', 'type' => 'string', 'required' => true, 'example' => 'accountId1'], ], [ - 'name' => 'ToPhoneNum', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0571773', - ], + 'schema' => ['title' => '', 'description' => 'The name of the account to be synchronized.', 'type' => 'string', 'required' => true, 'example' => 'accountName1'], ], [ - 'name' => 'EndReason', + 'name' => 'DisplayName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'The display name of the agent.', 'type' => 'string', 'required' => false, 'example' => '张三'], ], [ - 'name' => 'UserInfo', + 'name' => 'SkillGroupIds', 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of skill group IDs.', + 'type' => 'array', + 'items' => ['description' => 'The skill group ID.'."\n" + ."\n" + .'The specified skill groups must belong to the same skill group category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, - 'example' => '{\\"level\\":25,\\"name\\":\\"Lee\\"}', + 'example' => '', ], ], [ - 'name' => 'RecordUrl', + 'name' => 'RoleIds', 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of role IDs.', + 'type' => 'array', + 'items' => ['description' => 'The role ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, - 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', + 'example' => '', ], ], - [ - 'name' => 'BizType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'SHOP_ID', + 'title' => '', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'xxx'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The ID of the newly created agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'Success'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + '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.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a third-party SSO agent', + 'changeSet' => [ + ['createdAt' => '2021-05-18T14:52:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'], + ], + ], + 'ramActions' => [], + ], + 'CreateTicket' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BizId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '78604', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ExtInfo', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"isCallBack\\":\\"true\\"}', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '546754', 'title' => ''], ], - ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the tree category. If this parameter is not specified, the category of the ticket template is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the creator (agent ID).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '555555', 'title' => ''], + ], + [ + 'name' => 'CreatorType', + 'in' => 'formData', + 'schema' => ['description' => 'The role of the creator. Default value: 4. Valid values:'."\n" + ."\n" + .'- 1: member'."\n" + .'- 4: customer service representative.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'CreatorName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the creator.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '刘测试', 'title' => ''], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the member. Set this parameter to -1 for an anonymous member.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '-1', 'title' => ''], + ], + [ + 'name' => 'MemberName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the member.', 'type' => 'string', 'required' => false, 'example' => '匿名会员', 'title' => ''], + ], + [ + 'name' => 'FromInfo', + 'in' => 'formData', + 'schema' => ['description' => 'The source from which the ticket is created.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'manual', 'title' => ''], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The priority of the ticket. Valid values:'."\n" + ."\n" + .'- 4: Normal.'."\n" + .'- 0: Low.'."\n" + .'- 1: Medium.'."\n" + .'- 2: High.'."\n" + .'- 3: Urgent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '4', 'title' => ''], + ], + [ + 'name' => 'CarbonCopy', + 'in' => 'formData', + 'schema' => ['description' => 'The account IDs of the carbon copy recipients. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '234432', 'title' => ''], + ], + [ + 'name' => 'FormData', + 'in' => 'formData', + 'schema' => ['description' => 'The form configuration of the ticket template, in the format {"key":"value"}. key: the form field code. value: the record value. Example: {"questionInfo":"Automatically created ticket","CFQyYAPjKb":"Delamination"}.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"questionInfo":"自动化创建工单","CFQyYAPjKb":"开胶"}', 'title' => ''], + ], + ], '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2500000010', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'StartHotlineService' => [ - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2500000010,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a ticket', + 'summary' => 'Creates a ticket.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteAgent' => [ + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2206,43 +1531,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID used for idempotency verification. You can use UUID to generate the ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the AICCS instance. You can view the instance ID in the Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the agent account. The name must be unique within the instance. It is used as the logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ @@ -2251,61 +1557,91 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used for troubleshooting.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoAgentFound', - 'errorMessage' => 'The specified agent does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n0079e7a845e37334ff\\nSuccess\\ntrue","errorExample":""}]', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Delete Agent', + 'summary' => 'Deletes an agent account from the AICCS Customer Service Workbench based on the agent account name. This operation performs a logical deletion. If you re-add the agent after the deletion, the agent ID remains unchanged.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'ListHotlineRecord' => [ - 'methods' => [ - 'get', + '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', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DisableRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2314,43 +1650,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AICCS instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100365558', - ], + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => ['description' => 'The role ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '555555', 'title' => ''], ], ], 'responses' => [ @@ -2359,636 +1676,321 @@ '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n false\\n false\\n 100365548\\n 100365558\\n http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'QueryHotlineSession' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Disable a role', + 'summary' => 'Disables role permissions in the Cloud Customer Service System by role ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'EditEntityRoute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Acid', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - ], + 'name' => 'EntityName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CallType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '0', - 'default' => '', - 'enum' => [ - '1', - '2', - ], - ], + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'EntityBizCodeType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CallingNumber', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ '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, - ], + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ServiceId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ExtInfo', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'QueryEndTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'default' => '', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'QueryStartTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'default' => '', - ], + 'name' => 'UniqueId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'RequestId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ServicerName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'EnableRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ServicerId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], [ - 'name' => 'Params', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '50', - 'minimum' => '1', - 'default' => '10', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'default' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AICCS instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CallResult', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'enum' => [ - 'normal', - 'touchRouteError', - 'touchInQueue', - 'touchInLoss', - 'userHangup', - 'sysHangup', - 'transferAgent', - 'dailing', - 'TouchRingCallLoss', - ], - ], + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => ['description' => 'The role ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '555555', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', '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', - ], - ], - ], - ], - ], - ], + 'Message' => ['description' => 'The fault description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of a fault.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The fault encoding.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API operation is invoked successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'GetHotlineAgentDetailReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Enable a role', + 'summary' => 'Enables role permissions in the Cloud Customer Service System by role ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ExecuteActivity' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], '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' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'name' => 'TicketId', + 'in' => 'formData', + 'schema' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2500000010', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'OperatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the operator.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '555555', 'title' => ''], ], [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'name' => 'ActivityCode', + 'in' => 'formData', + 'schema' => ['description' => 'The activity code. You can use a system code or modify the system code to use a custom code.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'finish', 'title' => ''], ], [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'name' => 'ActivityForm', + 'in' => 'formData', + 'schema' => ['description' => 'The extended field for the action record, such as {"ProcessType":"Refund","CompensationAmount":"12","ProcessContent":"Properly handled","ProcessTime":"2020-09-21"}.', 'type' => 'string', 'required' => false, 'example' => '{"处理类型":"退费","赔偿金额":"12","处理内容":"已妥善处理","处理时间":"2020-09-21"}\'', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', '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', - ], - ], - ], - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'GetHotlineAgentStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Process a ticket', + 'summary' => 'Executes a custom activity.', + 'extraInfo' => '1) Example of the content passed in activityForm: {"处理类型":"退费","赔偿金额":"12","处理内容":"已妥善处理","处理时间":"2020-09-21"}'."\n" + .'2) When defining an activity code, use a custom code (system activities do not support custom codes). For example, manually change the activity code of the audit group leader to "group" and complete the change before creating the ticket for the specified activity to take effect. See the following figure:'."\n" + .'https://cdn.nlark.com/yuque/0/2021/png/21395124/1619081827743-b753b777-d37f-466c-9df4-62e386b46aa2.png.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'FetchCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotency verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Contact Center (AICCS) instance. You can view this ID in the Chinese Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId from the WebSocket message after an inbound call is received. This parameter is required only for a two-step transfer.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -2997,147 +1999,124 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n通话中\\nSuccess\\ntrue","errorExample":""}]', - ], - 'GetHotlineGroupDetailReport' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve call information', + 'summary' => 'Retrieves or resumes a call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'FinishHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'default' => '1', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'default' => '10', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'StartDate', - 'in' => 'query', + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The account name of the agent (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'default' => '', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'End hotline service', + 'summary' => 'Signs out an agent to end the hotline service.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'FinishHotlineServiceNew' => [ + 'summary' => 'API for ending a hotline agent\'s shift. For more information, see FinishHotlineService. The request fails if the agent is on a call.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'AK' => [], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3145,160 +2124,130 @@ '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', - ], - ], - ], - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'GetOuterCallCenterDataList' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-02T11:54:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + ], + 'GenerateWebSocketSign' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'SessionId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'a15ce370-1051-4040-9822', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'FromPhoneNum', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '135615', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'ToPhoneNum', + 'name' => 'AccountName', 'in' => 'formData', + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0571773', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The messagebox message channel signature code.', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'BizId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '78604', - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'Generate messagebox channel signature', + 'summary' => 'Generates an access signature for a message channel.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetAgent' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'AK' => [], ], [ - 'name' => 'QueryStartTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1614824872', - ], + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'QueryEndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1614824972', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The account name of the agent. This value is unique within the instance and is used as the logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ @@ -3307,111 +2256,76 @@ 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'RequestId' => ['description' => 'The request ID, which is used to track error causes.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], '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', + 'description' => 'The agent data.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the agent. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Frozen.'."\n" + .'- 2: Deleted.'."\n" + ."\n" + .'Only agents in the Normal state can perform business activities.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the agent.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'AgentId' => ['description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '222222', 'title' => ''], + 'GroupList' => [ + 'description' => 'The skill group information to which the agent belongs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The skill group information.', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'Description' => ['description' => 'The description of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'ChannelType' => ['description' => 'The channel type of the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SkillGroupId' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'AccountName' => ['description' => 'The account name of the agent (logon name).', 'type' => 'string', 'example' => '123@123.com', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID to which the agent belongs. This value has a one-to-one mapping with the instance ID specified in the request parameters.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n 3\\n 1\\n 100365558\\n 0571773\\n {\\\\\\"level\\\\\\":25,\\\\\\"name\\\\\\":\\\\\\"Lee\\\\\\"}\\n 16085570\\n 78604\\n a15ce370-1051-4040-9822\\n 135615\\n {\\\\\\"isCallBack\\\\\\":\\\\\\"true\\\\\\"}\\n SHOP_ID\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'SendHotlineHeartBeat' => [ - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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\\": \\"123@123.com\\",\\n \\"TenantId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0,\\n \\"Message\\": \\"\\"\\n}","type":"json"}]', + 'title' => 'Get agent details', + 'summary' => 'Queries the information about an agent in the Cloud Customer Service System by agent account name.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetAgentHotline' => [ + 'summary' => 'Query hotline agent information and hotline skill groups ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3420,110 +2334,94 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['title' => 'Unique ID of the Customer request, used for idempotency validation; it can be generated using UUID', 'type' => 'string', 'description' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['title' => 'AICCS instance ID, which can be found in the Artificial Intelligence Cloud Call Service console', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], - ], - [ - 'name' => 'Token', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0079e7a845e37334ff', - ], + 'schema' => ['title' => 'Agent account name (unique value), mapping between external account and XP account logon name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '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' => [ + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => 'Tenant ID ', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'AgentId' => ['title' => 'Agent ID ', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'AccountName' => ['title' => 'Agent account name (agent logon name)', 'type' => 'string', 'description' => '', 'example' => ''], + 'DisplayName' => ['title' => 'XP account display name ', 'type' => 'string', 'description' => '', 'example' => ''], + 'GroupList' => [ + 'title' => 'Hotline skill groups ', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillGroupId' => ['title' => 'Skill group ID ', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'Name' => ['title' => 'Skill group name ', 'type' => 'string', 'description' => '', 'example' => ''], + 'DisplayName' => ['title' => 'Skill group display name ', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + 'DepartmentId' => ['title' => 'Department ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'AgentPhone' => ['title' => 'Agent-bound phone number ', 'type' => 'string', 'description' => '', 'example' => ''], + 'SkillGroups' => ['title' => 'Hotline skill groups, format: "[123,456,......,789]" ', 'type' => 'string', 'description' => '', 'example' => ''], + 'ExtAttr' => ['title' => 'Extension field ', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'SuspendHotlineService' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": {\\n \\"TenantId\\": 0,\\n \\"AgentId\\": 0,\\n \\"AccountName\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"GroupList\\": [\\n {\\n \\"SkillGroupId\\": 0,\\n \\"Name\\": \\"\\",\\n \\"DisplayName\\": \\"\\"\\n }\\n ],\\n \\"DepartmentId\\": \\"\\",\\n \\"AgentPhone\\": \\"\\",\\n \\"SkillGroups\\": \\"\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetAgentHotlinePhone' => [ + 'summary' => 'Retrieves the extended information of a support agent.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3532,109 +2430,62 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['title' => '', 'description' => 'The unique client request ID used for idempotency checks. You can use a UUID.', '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-***', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the agent account (unique value). This is the mapping between the external account and the XP account logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '', + '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', - ], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'NoTenantFound', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'example' => '136********'], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'TransferCallToPhone' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"136********\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","type":"json"}]', + 'title' => 'Query agent bound phone number', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetAgentWorkStatus' => [ + 'summary' => 'Queries the sign-in and sign-out status of an agent.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3643,328 +2494,306 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['title' => '', 'description' => 'The unique client request ID for idempotence checks. You can use a UUID.', '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-***', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['title' => '', 'description' => 'The agent account name (unique value). This is the mapping between the external account and the XP account.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'], ], - [ - 'name' => 'Caller', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '9065446', + 'title' => '', + 'description' => 'Result', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'NoTenantFound', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], + 'Data' => [ + 'description' => 'The agent work status object.', + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => '', 'description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '905'], + 'AgentId' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1059054'], + 'AccountName' => ['title' => '', 'description' => 'The agent account name (agent logon name).', 'type' => 'string', 'example' => '123@123.com'], + 'AgentStatusCode' => ['title' => '', 'description' => 'The agent work status code.', 'type' => 'string', 'example' => 'AgentCheckin'], + 'AgentStatusDesc' => ['title' => '', 'description' => 'The description of the agent work status.', 'type' => 'string', 'example' => '坐席签入状态'], + 'WorkChannel' => ['title' => '', 'description' => 'The work channel. PSTN indicates that the agent works by using a mobile phone. PC indicates that the agent works by using a computer.', 'type' => 'string', 'example' => 'PC'], + 'ExtAttr' => ['title' => '', 'description' => 'The extended field.', 'type' => 'string', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'Callee', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '136098792', - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"TenantId\\": 905,\\n \\"AgentId\\": 1059054,\\n \\"AccountName\\": \\"123@123.com\\",\\n \\"AgentStatusCode\\": \\"AgentCheckin\\",\\n \\"AgentStatusDesc\\": \\"坐席签入状态\\",\\n \\"WorkChannel\\": \\"PC\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","type":"json"}]', + 'title' => 'Query hotline agent work status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetAllDepartment' => [ + 'summary' => 'Obtain the department list under a specified tenant ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719786', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719787', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => 'AICCS instance ID, which can be found in the Artificial Intelligence Cloud Call Service console ', 'type' => 'string', 'description' => '', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'], ], - [ - 'name' => 'ConnectionId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => 'Schema of Response ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'ID of the request ', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepartmentId' => ['type' => 'integer', 'description' => '', 'format' => 'int64', 'title' => '', 'example' => ''], + 'DepartmentName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'integer', 'description' => '', 'format' => 'int32', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719788', + 'example' => '', ], ], - [ - 'name' => 'HoldConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0', - ], + ], + 'changeSet' => [ + ['createdAt' => '2021-12-16T13:32:40.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllDepartment'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"DepartmentId\\": 0,\\n \\"DepartmentName\\": \\"\\",\\n \\"Status\\": 0\\n }\\n ],\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + ], + 'GetAuthInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'IsSingleTransfer', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'callerPhone', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'calleePhone', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'AppKey', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', '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' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Time' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'AppKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'App' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SessionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 201 => [ + ['errorCode' => 'GetAuthInfoFailed', 'errorMessage' => 'Failed to get authorization information.', 'description' => ''], + ], + [ + ['errorCode' => 'GetTenantIdFailed', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'TransferCallToSkillGroup' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"AppName\\": \\"\\",\\n \\"Time\\": 0,\\n \\"AppKey\\": \\"\\",\\n \\"App\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"SessionId\\": \\"\\",\\n \\"UserName\\": \\"\\",\\n \\"TenantId\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetByForeignId' => [ + 'summary' => 'Retrieves the member account relationship information mapped to an external account.', + '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-***', - ], + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SkillGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '356543', - ], + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'CallId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719786', + 'example' => '', ], ], + ], + 'changeSet' => [ + ['createdAt' => '2021-09-22T15:19:30.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetByForeignId'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + ], + 'GetCMSIdByForeignId' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719787', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719788', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'HoldConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'Nick', + 'in' => 'query', + 'schema' => ['description' => 'The nickname.', 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'ForeignId', + 'in' => 'query', + 'schema' => ['description' => 'The external ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zhangsan', 'title' => ''], ], [ - 'name' => 'IsSingleTransfer', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'SourceId', + 'in' => 'query', + 'schema' => ['description' => 'The source of the user.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -3973,356 +2802,316 @@ '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', + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The account information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The account status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CustomerTypeId' => ['description' => 'The customer type.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Avatar' => ['description' => 'The profile picture.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Gender' => ['description' => 'The gender.', 'type' => 'string', 'example' => 'male', 'title' => ''], + 'ForeignId' => ['description' => 'The external ID.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'Nick' => ['description' => 'The nickname.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'Anonymity' => ['description' => 'Indicates whether the user is anonymous.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Phone' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '131111111111', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'TransferToThirdCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve cmsId by foreignId', + 'summary' => 'Retrieves a customer ID based on an external ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetCallsPerDay' => [ + 'summary' => 'Retrieves the daily number of incoming hotline calls.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + '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' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'DataIdStart', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'string', 'required' => true, 'example' => '20210316', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'name' => 'DataIdEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end time.', 'type' => 'string', 'required' => true, 'example' => '20210316', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719786', - ], + 'name' => 'DataId', + 'in' => 'query', + 'schema' => ['description' => 'The query results grouped by day.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719787', - ], + 'name' => 'HourId', + 'in' => 'query', + 'schema' => ['description' => 'The query results grouped by hour.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ - 'name' => 'ConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719788', - ], + 'name' => 'MinuteId', + 'in' => 'query', + 'schema' => ['description' => 'The query results grouped by minute.', 'type' => 'string', 'required' => false, 'example' => 'Y', 'title' => ''], ], [ - 'name' => 'HoldConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'schema' => ['description' => 'The phone numbers. Separate multiple phone numbers with commas (,).', 'type' => 'string', 'required' => false, 'example' => '1583709xxxx', 'title' => ''], + ], + [ + 'name' => 'HavePhoneNumbers', + 'in' => 'query', + 'schema' => ['description' => 'The phone numbers. Separate multiple phone numbers with commas (,).', 'type' => 'string', 'required' => false, 'example' => '1583709xxxx', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '', + 'description' => 'Schema of Response', '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', + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'phoneNum and havePhoneNum must be either empty or not empty at the same time', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '45FAB8AB-CFB3-4582-B1A5-9010DEADD8F9', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidPhone', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'data', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CallsPerdayResponseList' => [ + 'description' => 'array', + 'type' => 'array', + 'items' => [ + 'description' => 'object', + 'type' => 'object', + 'properties' => [ + 'DataId' => ['description' => 'The data grouped by day.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'HourId' => ['description' => 'The data grouped by hour.', 'type' => 'string', 'example' => '-1', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'TenantName' => ['description' => 'The tenant name.', 'type' => 'string', 'example' => '50', 'title' => ''], + 'PhoneNum' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1583709xxxx', 'title' => ''], + 'CallOutCnt' => ['description' => 'The number of outbound calls.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CallInCnt' => ['description' => 'The number of incoming calls.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'MinuteId' => ['description' => 'The data grouped by minute.', 'type' => 'string', 'example' => '-1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ + 202 => [ + ['errorCode' => 'GetTenantIdFailed', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], + 400 => [ + ['errorCode' => 'DataIdEndError', 'errorMessage' => 'dataIdStart must be a time stamp and cannot be empty.', 'description' => ''], + ['errorCode' => 'DataIdStartError', 'errorMessage' => 'dataIdEnd must be a time stamp and cannot be empty.', 'description' => ''], + ['errorCode' => 'InvalidPhone', 'errorMessage' => 'phoneNum and havePhoneNum must be either empty or not empty at the same time.', 'description' => ''], + ], 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.', - ], + ['errorCode' => 'InstanceIdCannotBeNull', 'errorMessage' => 'You must specify InstanceId.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'FinishHotlineService' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve daily incoming hotline call count', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallsPerDay'], + ], ], + ], + 'GetEntityRoute' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'EntityId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UniqueId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'EntityName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EntityRelationNumber', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EntityBizCode', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', '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' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'EntityBizCodeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EntityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServiceId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EntityBizCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UniqueId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EntityName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExtInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityRelationNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'CreateRole' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"EntityBizCodeType\\": \\"\\",\\n \\"GroupId\\": 0,\\n \\"EntityId\\": \\"\\",\\n \\"ServiceId\\": 0,\\n \\"EntityBizCode\\": \\"\\",\\n \\"DepartmentId\\": \\"\\",\\n \\"UniqueId\\": 0,\\n \\"EntityName\\": \\"\\",\\n \\"ExtInfo\\": \\"\\",\\n \\"EntityRelationNumber\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetEntityRouteList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageNo', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'RoleName', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Operator', + 'name' => 'EntityRelationNumber', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PermissionId', + 'name' => 'EntityName', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => true, - 'maxItems' => 200, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4330,158 +3119,213 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EntityRouteList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EntityBizCodeType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServiceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityBizCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UniqueId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EntityName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExtInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityRelationNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'DisableRole' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PageNo\\": 0,\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"EntityRouteList\\": [\\n {\\n \\"EntityBizCodeType\\": \\"\\",\\n \\"GroupId\\": \\"\\",\\n \\"EntityId\\": \\"\\",\\n \\"ServiceId\\": \\"\\",\\n \\"DepartmentId\\": \\"\\",\\n \\"EntityBizCode\\": \\"\\",\\n \\"UniqueId\\": 0,\\n \\"EntityName\\": \\"\\",\\n \\"ExtInfo\\": \\"\\",\\n \\"EntityRelationNumber\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetEntityTagRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'EntityId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'string', 'required' => false, 'maxLength' => 9.223372036854776E+18, 'minLength' => -1, 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'EntityType', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 9.223372036854776E+18, 'minLength' => -1, 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'RoleId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '555555', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', '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' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": [\\n {\\n \\"TagName\\": \\"\\",\\n \\"TagGroupCode\\": \\"\\",\\n \\"EntityId\\": \\"\\",\\n \\"TagCode\\": \\"\\",\\n \\"EntityType\\": \\"\\",\\n \\"TagGroupName\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'EnableRole' => [ - 'methods' => [ - 'post', + 'GetForeignIdByCMSId' => [ + 'summary' => 'Obtain ForeignId by CMSId', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CustomerTypeId' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Avatar' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Gender' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ForeignId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Nick' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Anonymity' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Phone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetForeignIdByCMSId'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"CustomerTypeId\\": 0,\\n \\"Avatar\\": \\"\\",\\n \\"Gender\\": \\"\\",\\n \\"ForeignId\\": \\"\\",\\n \\"UserId\\": \\"\\",\\n \\"Nick\\": \\"\\",\\n \\"Anonymity\\": false,\\n \\"Phone\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'GetGrantedRoleIds' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4490,46 +3334,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'RoleId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '555555', - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The agent account name, which is unique within the instance (logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ @@ -4538,215 +3360,196 @@ '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', + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The role ID.', + 'type' => 'array', + 'items' => ['description' => 'The role ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '{555555，777777}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'CreateTicket' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve role iDs granted to a user', + 'summary' => 'Queries the role permissions of an agent in the Cloud Customer Service System based on the agent account name.', + 'changeSet' => [ + ['createdAt' => '2021-05-18T14:52:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetHotlineAgentDetail' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of AICCS. You can find this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'TemplateId', - 'in' => 'formData', + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The account name of the agent, which is unique within the instance (logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '546754', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The agent service data.', + 'type' => 'object', + 'properties' => [ + 'AgentStatusCode' => ['description' => 'The agent status code. Valid values:'."\n" + .'1: AgentCheckout (agent checked out)'."\n" + .'3: AgentReady (agent idle)'."\n" + .'4: AgentBreak (agent on break)'."\n" + .'5: AgentAcw (after-call work)'."\n" + .'6: AgentBusyForCall (on a call).', 'type' => 'string', 'example' => 'AgentCheckout', 'title' => ''], + 'Token' => ['description' => 'The heartbeat signature.', 'type' => 'string', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'Assigned' => ['description' => 'Indicates whether the agent is assigned. Valid values:'."\n" + .'- false: Not assigned (no active call).'."\n" + .'- true: Assigned (active call).', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'RestType' => ['description' => 'The break type. Valid values:'."\n" + .'- 1: Break.'."\n" + .'- 2: Meal. '."\n" + .'- 3: Meeting. '."\n" + .'- 4: Coaching.'."\n" + .'- 5: Training.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AgentStatus' => ['description' => 'The agent status. Valid values: 1 to 6.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant to which the agent belongs. This ID has a one-to-one mapping with the instance ID specified in the request parameters.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve hotline agent details', + 'summary' => 'Retrieves the current service details of a hotline agent by agent account.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetHotlineAgentDetailReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CategoryId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '10000', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'CreatorId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '555555', - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CreatorType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '4', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CreatorName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '-1', - ], + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberName', - 'in' => 'formData', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, + 'maxItems' => 200, + 'description' => '', + 'title' => '', 'example' => '', ], ], [ - 'name' => 'FromInfo', - 'in' => 'formData', + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'repeatList', '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', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, - 'example' => '234432', - ], - ], - [ - 'name' => 'FormData', - 'in' => 'formData', - 'schema' => [ + 'maxItems' => 200, 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'title' => '', 'example' => '', ], ], @@ -4754,295 +3557,205 @@ 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Page' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Title' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Rows' => [ + 'type' => 'array', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2500000010', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"Data\\": {\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"Page\\": 0,\\n \\"Columns\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Title\\": \\"\\"\\n }\\n ],\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetHotlineAgentDetailWithChannel' => [ + 'summary' => 'Same as GetHotlineAgentDetail, returns the work channel.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ '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', - ], + 'in' => 'query', + 'schema' => ['title' => 'AICCS instance ID, which can be found in the Artificial Intelligence Cloud Call Service console', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ - 'name' => 'FormData', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['title' => 'Agent account name (Unique value), mapping between external account and XP account logon name', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', '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' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'AgentStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Token' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AgentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Assigned' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'RestType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'AgentStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TenantId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'WorkChannel' => ['title' => 'Work channel: PC for computer-based logon, PSTN for Phone-based logon', 'type' => 'string', 'description' => '', 'example' => ''], + 'ExtAttr' => ['title' => 'Extension field', 'type' => 'string', 'description' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'title' => '', + 'example' => '', ], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'QueryTicketActions' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-13T11:50:46.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"AgentStatusCode\\": \\"\\",\\n \\"Token\\": \\"\\",\\n \\"AgentId\\": 0,\\n \\"Assigned\\": false,\\n \\"RestType\\": 0,\\n \\"AgentStatus\\": 0,\\n \\"TenantId\\": 0,\\n \\"WorkChannel\\": \\"\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => '', + ], + 'GetHotlineAgentStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + '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, - ], + 'schema' => ['description' => 'The AICCS instance ID. You can find this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'ActionCodeList', + 'name' => 'AccountName', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The agent account name, which is unique within the instance (login name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'The fault description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of a fault.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The agent status (offline, idle, post-processing, in call, break-rest, break-meal, break-meeting, break-training, or break-coaching).', 'type' => 'string', 'example' => '通话中', 'title' => ''], + 'Code' => ['description' => 'The fault encoding.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was successfully invoked.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [], - 'responseDemo' => null, - ], - 'QueryTicketCount' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"通话中\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve hotline agent status', + 'summary' => 'Queries the hotline agent status in the Cloud Customer Service System by agent account name.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetHotlineGroupDetailReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5050,107 +3763,129 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'default' => '', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 200, 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'OperatorId', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 200, 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '666666', + 'title' => '', + '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' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], '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.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Page' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Title' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Rows' => [ + 'type' => 'array', + 'items' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n45\\nSuccess\\ntrue","errorExample":""}]', - ], - 'QueryTickets' => [ - 'summary' => '查询工单', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": \\"\\",\\n \\"Data\\": {\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"Page\\": 0,\\n \\"Columns\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Title\\": \\"\\"\\n }\\n ],\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetHotlineWaitingNumber' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5159,293 +3894,289 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'CaseId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CaseType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], - [ - 'name' => 'CaseStatus', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1000', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The number of hotline members in the queue.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'View hotline queue count for the skill group of the current agent', + 'summary' => 'Retrieves the number of hotline members in the queue.', + 'changeSet' => [ + ['createdAt' => '2021-05-18T14:52:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetNumLocation' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SrType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'AK' => [], ], [ - 'name' => 'TaskStatus', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-10000000', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'ChannelId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID, used for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ChannelType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-10000000', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'TouchId', - 'in' => 'formData', + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136098792', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used for tracing the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The location to which the phone number belongs.', 'type' => 'string', 'example' => '杭州', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Retrieve phone number location', + 'summary' => 'Retrieves the location to which a phone number belongs.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetOnlineTouchSessionList' => [ + 'summary' => 'Query the list of online session records (by touch dimension)', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DealId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'AK' => [], ], [ - 'name' => 'Extra', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - 'required' => false, - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'AccountName', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['title' => 'Instance ID ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ - 'name' => 'ParentCaseId', + 'name' => 'GroupIds', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'maxItems' => 10, + 'title' => 'Skill group ID ', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'example' => '', ], ], [ - 'name' => 'StartCaseGmtCreate', + 'name' => 'StartDate', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['title' => 'Start Time [filter range based on session connection time]. Format: UNIX timestamp (milliseconds)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ - 'name' => 'EndCaseGmtCreate', + 'name' => 'EndDate', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['title' => 'End time [filter range for session connection time], in UNIX timestamp (milliseconds) ', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'CurrentPage', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'default' => '10', - ], + 'schema' => ['title' => 'Current page ', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '5000', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['title' => 'Page size. Default value: 10. Maximum value: 30 ', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'PageResult', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['title' => 'Error code', 'type' => 'string', 'description' => '', 'example' => ''], + 'Message' => ['title' => 'error message', 'type' => 'string', 'description' => '', 'example' => ''], 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UserForeignId' => ['title' => 'External Membership ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'SessionId' => ['title' => 'Session ID, Unique encoding of the MessageInfo instance object; has a one-to-many relationship with TouchId', 'type' => 'string', 'description' => '', 'example' => ''], + 'TouchId' => ['title' => 'Touch ID; when a user contacts and is transferred to different agents multiple times, multiple touch IDs are generated', 'type' => 'string', 'description' => '', 'example' => ''], + 'ChannelId' => ['title' => 'Channel encoding for this contact, same as sid', 'type' => 'string', 'description' => '', 'example' => ''], + 'GroupId' => ['title' => 'Skill group ID', 'type' => 'string', 'description' => '', 'example' => ''], + 'GroupName' => ['title' => 'Skill group Name', 'type' => 'string', 'description' => '', 'example' => ''], + 'FirstTime' => ['title' => 'Session connection time, UNIX timestamp', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'MessageInfo' => [ + 'title' => 'List of detailed conversation records', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MessageId' => ['title' => 'Message serial number', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'SenderId' => ['title' => 'ID of the message sender', 'type' => 'string', 'description' => '', 'example' => ''], + 'SenderName' => ['title' => 'Name of the message sender', 'type' => 'string', 'description' => '', 'example' => ''], + 'SenderType' => ['title' => 'Message sender type. Enumeration values: 1 for Membership, 2 for customer service', 'type' => 'string', 'description' => '', 'example' => ''], + 'Content' => ['title' => 'Content of the message', 'type' => 'string', 'description' => '', 'example' => ''], + 'GmtCreated' => ['title' => 'Actual time when the message was sent. Format: UNIX timestamp', 'type' => 'string', 'description' => '', 'example' => ''], + 'Status' => ['title' => 'Status of the message log. 0 indicates default, and 50 indicates revoked.', 'type' => 'string', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageNo' => ['title' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'TotalResults' => ['title' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'PageSize' => ['title' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'SearchTicketById' => [ - 'summary' => '查询工单信息', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-10-20T12:53:48.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"UserForeignId\\": \\"\\",\\n \\"SessionId\\": \\"\\",\\n \\"TouchId\\": \\"\\",\\n \\"ChannelId\\": \\"\\",\\n \\"GroupId\\": \\"\\",\\n \\"GroupName\\": \\"\\",\\n \\"FirstTime\\": 0,\\n \\"MessageInfo\\": [\\n {\\n \\"MessageId\\": 0,\\n \\"SenderId\\": \\"\\",\\n \\"SenderName\\": \\"\\",\\n \\"SenderType\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"GmtCreated\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"\\",\\n \\"HttpStatusCode\\": 0,\\n \\"PageNo\\": 0,\\n \\"TotalResults\\": 0,\\n \\"PageSize\\": 0\\n}","type":"json"}]', + 'title' => '', + ], + 'GetOutbounNumList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID used for idempotency checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AICCS instance. You can view this ID in the Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'StatusCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '12001', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ @@ -5454,644 +4185,389 @@ 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The number list information.', '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' => '', + 'NumGroup' => [ + 'description' => 'The number group information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The number group information.', 'type' => 'object', 'properties' => [ - 'ActivityFormData' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'ActivityCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'finish', - ], + 'Type' => ['description' => 'The type. Valid values:'."\n" + .'1: number.'."\n" + .'2: number group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Value' => ['description' => 'The number group ID.', 'type' => 'string', 'example' => 'Jella', 'title' => ''], + 'Description' => ['description' => 'The number group description (number group name).', 'type' => 'string', 'example' => '76', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ActivityRecords' => [ - 'description' => '', + 'Num' => [ + 'description' => 'The caller number information.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The caller number information.', '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', - ], + 'Type' => ['description' => 'The type. Valid values:'."\n" + .'1: number.'."\n" + .'2: number group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Value' => ['description' => 'The caller number.', 'type' => 'string', 'example' => '9065446', 'title' => ''], + 'Description' => ['description' => 'The caller number description (location information).', 'type' => 'string', 'example' => '浙江省杭州市', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - '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', + 'title' => '', 'example' => '', ], - 'ParentCaseId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n 234432\\n 匿名会员\\n 1614824872\\n 555555\\n 2500000010\\n 1\\n 555555\\n {\\"questionInfo\\":\\"自动化创建工单\\"}\\n \\n {\\\\\\"BQ73dGsSNs\\\\\\":\\\\\\"备注\\\\\\"}\\n finish\\n \\n \\n 997015\\n 创建工单\\n 刘测试\\n {\\"CFQyYAPjKb\\":\\"开胶\\"}\\n 1614824772\\n \\n hotline\\n 1614824872\\n 刘测试\\n 10000\\n 4\\n 1876543\\n 6\\n 546754\\n 自动化工单\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'SearchTicketByPhone' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve outbound number list', + 'summary' => 'Retrieves the list of external hotline numbers.', + 'changeSet' => [ + ['createdAt' => '2021-04-14T08:50:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetOuterCallCenterDataList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'SessionId', + 'in' => 'formData', + 'schema' => ['description' => 'The session ID of the robot.', 'type' => 'string', 'required' => false, 'example' => 'a15ce370-1051-4040-9822', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'FromPhoneNum', + 'in' => 'formData', + 'schema' => ['description' => 'The caller number, such as a user mobile number, customer service representative seat number, or robot number.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '135615', 'title' => ''], ], [ - 'name' => 'Phone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '138999', - ], + 'name' => 'ToPhoneNum', + 'in' => 'formData', + 'schema' => ['description' => 'The callee number, such as a user mobile number, customer service representative seat number, or robot number.', 'type' => 'string', 'required' => false, 'example' => '0571773', 'title' => ''], ], [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '546754', - ], + 'name' => 'BizId', + 'in' => 'formData', + 'schema' => ['description' => 'The key document number, such as an order ID.', 'type' => 'string', 'required' => false, 'example' => '78604', 'title' => ''], ], [ - 'name' => 'TicketStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '6', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1', - ], + 'name' => 'QueryStartTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start timestamp, in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1614824872', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'QueryEndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end timestamp, in milliseconds.', 'type' => 'string', 'required' => false, 'example' => '1614824972', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '10', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The hotline data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hotline data.', + 'type' => 'object', + 'properties' => [ + 'EndReason' => ['description' => 'The hang-up reason. Valid values:'."\n" + .'1: The call ended due to transfer to a human agent.'."\n" + .'2: The call ended during the robot phase without being transferred to a human agent.'."\n" + .'3: The user actively hung up.'."\n" + .'4: The robot actively hung up.'."\n" + .'5: The call was disconnected due to a network exception.', 'type' => 'string', 'example' => '3', 'title' => ''], + 'CallType' => ['description' => 'The call type. Valid values:'."\n" + .'1: inbound.'."\n" + .'2: outbound.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Acid' => ['description' => 'The acid in the WebSocket after an inbound call.', 'type' => 'string', 'example' => '100365558', 'title' => ''], + 'ToPhoneNum' => ['description' => 'The callee number, such as a user mobile number, customer service representative seat number, or robot number.', 'type' => 'string', 'example' => '0571773', 'title' => ''], + 'UserInfo' => ['description' => 'The user information passed from the upstream system, recorded in JSON format.', 'type' => 'string', 'example' => '{\\"level\\":25,\\"name\\":\\"Lee\\"}', 'title' => ''], + 'InterveneTime' => ['description' => 'The time when the call was connected. For inbound calls, this is the same as gmt_create. For outbound calls, this is the time when the user answered.', 'type' => 'string', 'example' => '16085570', 'title' => ''], + 'BizId' => ['description' => 'The key document number, such as an order ID.', 'type' => 'string', 'example' => '78604', 'title' => ''], + 'SessionId' => ['description' => 'The session ID of the robot.', 'type' => 'string', 'example' => 'a15ce370-1051-4040-9822', 'title' => ''], + 'FromPhoneNum' => ['description' => 'The caller number, such as a user mobile number, customer service representative seat number, or robot number.', 'type' => 'string', 'example' => '135615', 'title' => ''], + 'ExtInfo' => ['description' => 'The business information from the upstream system in JSON format, such as robot instance information.', 'type' => 'string', 'example' => '{\\"isCallBack\\":\\"true\\"}', 'title' => ''], + 'BizType' => ['description' => 'The document number type, such as order.', 'type' => 'string', 'example' => 'SHOP_ID', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve external hotline data list', + 'summary' => 'Retrieves a list of external hotline data records.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetTagList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1614824872', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1614825972', - ], + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'maxLength' => 9.223372036854776E+18, 'minLength' => -1, 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => true, 'maxLength' => 9.223372036854776E+18, 'minLength' => -1, 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], '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' => [ + 'ScenarioCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagValues' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TagGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EntityRelationNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'string', + 'title' => '', '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', - ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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":"10\\nEE338D98-9BD3-4413-B165\\nxxxx\\n2\\n16\\n1\\n\\n 匿名会员\\n 234432\\n 1614824872\\n 555555\\n 2500000010\\n 1\\n 555555\\n {\\"questionInfo\\":\\"自动化创建工单\\"}\\n hotline\\n 1614824872\\n 处理中\\n 刘测试\\n 10000\\n 4\\n 1876543\\n 6\\n 546754\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'SearchTicketList' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": [\\n {\\n \\"ScenarioCode\\": \\"\\",\\n \\"TagGroupCode\\": \\"\\",\\n \\"TagGroupName\\": \\"\\",\\n \\"TagValues\\": [\\n {\\n \\"Status\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"TagName\\": \\"\\",\\n \\"TagGroupCode\\": \\"\\",\\n \\"TagCode\\": \\"\\",\\n \\"TagGroupName\\": \\"\\",\\n \\"EntityRelationNumber\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetTicketByCaseId' => [ + 'summary' => 'Queries ticket information for a database.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + '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-***', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OperatorId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '555555', - ], + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'TicketStatus', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'MemberId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SopCateId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ExtAttrs' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'BuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'SrType' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Owner' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'OwnerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CaseStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'FromInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ParentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6', + 'example' => '', ], ], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTicketByCaseId'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"MemberId\\": 0,\\n \\"QuestionId\\": \\"\\",\\n \\"QuestionInfo\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"SopCateId\\": 0,\\n \\"CaseType\\": 0,\\n \\"Priority\\": 0,\\n \\"ExtAttrs\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"BuId\\": 0,\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"EndTime\\": 0,\\n \\"SrType\\": 0,\\n \\"Owner\\": 0,\\n \\"OwnerName\\": \\"\\",\\n \\"CaseStatus\\": 0,\\n \\"ChannelId\\": \\"\\",\\n \\"DepartmentId\\": 0,\\n \\"FromInfo\\": \\"\\",\\n \\"ParentId\\": 0,\\n \\"CaseId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'GetTicketTemplateSchema' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '20', - 'default' => '20', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1614824872', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service. You can view this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '1614825972', - ], + 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483648', 'minimum' => '0', 'example' => '546754', 'title' => ''], ], ], 'responses' => [ @@ -6100,259 +4576,67 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The ticket template information.', 'type' => 'string', 'example' => '{\\"buId\\":{\\"title\\":\\"租户编码\\",\\"type\\":\\"string\\"},\\"sopCateId\\":{\\"title\\":\\"业务类目\\"}', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], - [ - 'errorCode' => 'InvalidOperation', - 'errorMessage' => 'The operation is invalid.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - '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":"20\\nEE338D98-9BD3-4413-B165\\nxxxx\\n3\\n45\\n1\\n\\n 匿名会员\\n 234432\\n 1614824872\\n 555555\\n 2500000010\\n 1\\n 555555\\n {\\"questionInfo\\":\\"自动化创建工单\\"}\\n hotline\\n 1614824872\\n 处理中\\n 刘测试\\n 10000\\n 4\\n 1876543\\n 6\\n 546754\\n\\nSuccess\\ntrue","errorExample":""}]', - ], - 'AssignTicket' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query template metadata', + 'summary' => 'Queries ticket template information by ticket template ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetUserToken' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['title' => '', 'description' => 'AICCS instance ID, which can be viewed in the Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ - 'name' => 'InstanceId', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['title' => '', 'description' => 'User ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '875436'], ], [ - 'name' => 'TicketId', + 'name' => 'Nick', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2500000010', - ], + 'schema' => ['title' => '', 'description' => 'User nickname.', 'type' => 'string', 'required' => false, 'example' => '花花'], ], [ - 'name' => 'OperatorId', + 'name' => 'AppKey', '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', - ], + 'schema' => ['title' => '', 'description' => 'Application access identifier, issued by the service provider.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '54678765'], ], ], 'responses' => [ @@ -6361,66 +4645,60 @@ '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', + 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'xxxx'], + 'RequestId' => ['title' => '', 'description' => 'Request ID, used for tracking the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-xxxx'], + 'Data' => [ + 'description' => 'Token information.', + 'type' => 'object', + 'properties' => [ + 'Expires' => ['description' => 'Token expiration date.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614528000000', 'title' => ''], + 'Token' => ['description' => 'User access token.', 'type' => 'string', 'example' => 'xxx-xxx-xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => 'Success'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 200 => [ + ['errorCode' => 'AppInvalid', 'errorMessage' => 'The APPKEY is invalid.', 'description' => ''], + ['errorCode' => 'UserIdNotNull', 'errorMessage' => 'UserId cannot be null.', 'description' => ''], + ['errorCode' => 'InvalidForeignId', 'errorMessage' => 'The ForeignId is invalid.', 'description' => ''], + ], 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], 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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'CloseTicket' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Get user token', + 'summary' => 'Obtains user token information for accessing the SCSP customer service workstation based on user ID.', + 'changeSet' => [ + ['createdAt' => '2021-05-06T10:38:19.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GrantRoles' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, @@ -6429,274 +4707,176 @@ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'TicketId', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2500000010', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ActionItems', + 'name' => 'Operator', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OperatorId', + 'name' => 'RoleId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '555555', + 'maxItems' => 200, + 'description' => '', + 'title' => '', + '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' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'ExecuteActivity' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 0,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'HangUpAgentMonitor' => [ + 'summary' => 'Hang up agent listener', + '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, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['title' => 'requestId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['title' => 'clientToken', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => ['title' => 'callerType', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => ['title' => 'callerUid', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'StsTokenCallerUid', + 'in' => 'query', + 'schema' => ['title' => 'stsTokenCallerUid', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['title' => 'InstanceId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'TicketId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '2500000010', - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['title' => 'AccountName', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'OperatorId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '555555', - ], + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['title' => 'CallId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'ActivityCode', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'finish', - ], + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => 'JobId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], [ - 'name' => 'ActivityForm', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => ['title' => 'ConnectionId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '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', - ], + 'Message' => ['title' => 'message', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'requestId', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['title' => 'code', 'type' => 'string', 'description' => '', 'example' => ''], + 'Success' => ['title' => 'success', 'type' => 'boolean', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], - '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.', - ], + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:42:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HangUpAgentMonitor'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', ], - 'AnswerCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'HangupCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6712,67 +4892,32 @@ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The instance ID of the AICCS instance. You can find this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ 'name' => 'CallId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719786', - ], + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719787', - ], + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], ], [ 'name' => 'ConnectionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '7719788', - ], + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], ], 'responses' => [ @@ -6781,801 +4926,879 @@ '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'AppMessagePush' => [ - 'summary' => 'app提交', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Hang up a call', + 'summary' => 'Hangs up a call by the agent.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'HangupThirdCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => '实例ID', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-ss001', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'title' => '用户编号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'title' => 'APP状态', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '-1', - 'example' => '1', - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid in the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ - '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', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId in the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId in the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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', - ], + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"123-123143-4\\nnull\\n200\\nSysytemError\\ntrue","errorExample":""}]', - ], - 'ChangeChatAgentStatus' => [ - 'summary' => '修改在线客服状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Hang up a three-party call', + 'summary' => 'Hangs up a three-party call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'HoldCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'title' => 'clientToken', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => '示例id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'title' => '账户名称', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'Method', + 'name' => 'CallId', 'in' => 'formData', - 'schema' => [ - 'title' => '修改到的状态类型', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'requestLogout', - 'enum' => [ - 'requestRest', - 'requestLogout', - 'restToWork', - ], - ], + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], ], '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"\\n xxx\\n EE338D98-9BD3-4413-B165\\n 200\\n 0\\n Agent.NotFound\\n true\\n","errorExample":""}]', - ], - 'CreateCustomer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Hold a call', + 'summary' => 'Holds a call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'JoinThirdCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', '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' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'BizType', - 'in' => 'query', - 'schema' => [ - 'description' => 'BizType', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xp_commerce_aliyun', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can find this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'TypeCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ - 'name' => 'Phone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1360000xxxx', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], [ - 'name' => 'ManagerName', - 'in' => 'query', + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId from the WebSocket after an inbound call is received. This parameter is required only for a two-step transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Join a three-party call', + 'summary' => 'Adds a third party to an ongoing call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListAgentBySkillGroupId' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Contacter', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'AK' => [], ], [ - 'name' => 'Industry', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'Position', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'Email', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'Dingding', + 'name' => 'SkillGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '666666', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123yiyo', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The agent information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data information.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The agent status. Valid values:'."\n" + .'- 0: Normal.'."\n" + .'- 1: Frozen.'."\n" + .'- 2: Deleted.'."\n" + ."\n" + .'Only agents in the Normal state can perform business activities.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the agent.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'AgentId' => ['description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '666666', 'title' => ''], + 'AccountName' => ['description' => 'The account name of the agent, which is unique within the instance. This value is used as the logon name.', 'type' => 'string', 'example' => '123@123.com', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID to which the agent belongs. This value has a one-to-one mapping with the instance ID specified in the request parameters.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 666666,\\n \\"AccountName\\": \\"123@123.com\\",\\n \\"TenantId\\": 0\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query agents by skill group ID', + 'summary' => 'Queries the agent list in the Cloud Customer Service System by skill group ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListAllHotLineSkillGroups' => [ + 'summary' => 'Query all hotline type skill groups and their categorization under a specific tenant ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OuterId', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10000011', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OuterIdType', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'RequestId' => ['title' => 'Id of the request ', 'type' => 'string', 'description' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DepGroup' => [ + 'type' => 'object', + 'properties' => [ + 'DepGroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepGroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SkillGroupAgents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SkillGroup' => [ + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SkillGroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Agents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AccountName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AgentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Acid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'JobId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ConnId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CustomerPhone' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '{"CustomerId":"24027"}', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], ], ], - '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":"创建成功\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'CreateEntityIvrRoute' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-01-21T08:05:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-12T02:42:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-21T03:07:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-15T11:57:30.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllHotLineSkillGroups'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": [\\n {\\n \\"DepGroup\\": {\\n \\"DepGroupName\\": \\"\\",\\n \\"DepGroupId\\": 0\\n },\\n \\"SkillGroupAgents\\": [\\n {\\n \\"SkillGroup\\": {\\n \\"DisplayName\\": \\"\\",\\n \\"SkillGroupId\\": 0\\n },\\n \\"Agents\\": [\\n {\\n \\"AccountName\\": \\"\\",\\n \\"DisplayName\\": \\"\\",\\n \\"AgentId\\": 0,\\n \\"Status\\": 0,\\n \\"Acid\\": \\"\\",\\n \\"JobId\\": \\"\\",\\n \\"ConnId\\": \\"\\",\\n \\"CustomerPhone\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '', + ], + 'ListHotlineRecord' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'EntityName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of AICCS. You can find this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'EntityBizCode', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100365558', 'title' => ''], ], - [ - 'name' => 'EntityBizCodeType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The hotline session information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hotline session recording information.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The recording end timestamp, in milliseconds.', 'type' => 'boolean', 'example' => '16128694810', 'title' => ''], + 'StartTime' => ['description' => 'The recording start timestamp, in milliseconds.', 'type' => 'boolean', 'example' => '16128694110', 'title' => ''], + 'ConnectionId' => ['description' => 'The connection ID.', 'type' => 'string', 'example' => '100365548', 'title' => ''], + 'CallId' => ['description' => 'The acid from the WebSocket after an inbound call.', 'type' => 'string', 'example' => '100365558', 'title' => ''], + 'Url' => ['description' => 'The URL of the recording file.', 'type' => 'string', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'EntityRelationNumber', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve hotline recording list', + 'summary' => 'Queries the list of hotline recordings by hotline session ID.', + 'changeSet' => [ + ['createdAt' => '2021-05-18T14:52:14.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListOutboundPhoneNumber' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DepartmentId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ServiceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ExtInfo', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of AICCS. You can view this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The outbound calling phone numbers.', + 'type' => 'array', + 'items' => ['description' => 'The outbound calling phone numbers.', 'type' => 'string', 'example' => '{9065446}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'CreateSkillGroup' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Retrieve outbound calling numbers for a specified agent', + 'summary' => 'Retrieves the outbound calling phone numbers for a specified agent.', + 'changeSet' => [ + ['createdAt' => '2021-04-14T08:50:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListSkillGroup' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID, used for idempotency check. You can use a UUID to generate it.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The AICCS instance ID, which can be found on the Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'SkillGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => ['description' => 'The channel type of the skill group. Valid values:'."\n" + .'0: returns all skill groups.'."\n" + .'1: hotline skill group.'."\n" + .'2: online skill group.'."\n" + .'3: online + hotline skill group.'."\n" + .'4: ticket skill group.'."\n" + .'5: hotline + ticket skill group.'."\n" + .'6: online + ticket skill group.'."\n" + .'7: online + hotline + ticket skill group.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '7', 'minimum' => '0', 'example' => '2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used to trace the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => [ + 'description' => 'The skill group information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data information.', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'Description' => ['description' => 'The description of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'ChannelType' => ['description' => 'The channel type of the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'SkillGroupId' => ['description' => 'The skill group ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query Skill Groups', + 'summary' => 'Queries skill groups in the XIXI Customer Service Workbench by skill group channel type.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'QueryHotlineDashboard' => [ + 'summary' => 'Queries hotline dashboard information by calling the QueryHotlineDashboard operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Description', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the [Artificial Intelligence Cloud Call Service console](https://help.aliyun.com/product/126730.html).', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_***'], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1636473600000'], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1636473600000'], + ], + [ + 'name' => 'DepartmentIdList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of department IDs.', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '10', 'title' => ''], 'required' => false, 'example' => '', ], ], [ - 'name' => 'DisplayName', - 'in' => 'formData', + 'name' => 'ServicerIdList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The list of agent IDs.', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'example' => '10', 'title' => ''], 'required' => false, 'example' => '', ], ], [ - 'name' => 'ChannelType', - 'in' => 'formData', + 'name' => 'SortFieldList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '7', - 'minimum' => '0', - 'example' => '2', + 'title' => '', + 'description' => 'The list of sort fields.', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '10', 'title' => ''], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'CurrentPageNum', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => 'Message', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RequestId' => [ - 'description' => 'RequestId', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'ccc_xp_pre-cn-***'], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The status description.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Code' => [ - 'description' => 'Code', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => 'Success', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The paginated data.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Results' => [ + 'description' => 'The hotline dashboard data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hotline dashboard data.', + 'type' => 'object', + 'properties' => [ + 'DateId' => ['title' => '', 'description' => 'The date.', 'type' => 'string', 'example' => '20211101'], + 'ServicerId' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '727272'], + 'ServicerShowName' => ['title' => '', 'description' => 'The display name of the agent.', 'type' => 'string', 'example' => '加油-小高'], + 'ServicerRealName' => ['title' => '', 'description' => 'The real name of the agent.', 'type' => 'string', 'example' => '加油-小高'], + 'DepartmentId' => ['title' => '', 'description' => 'The department ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11212121'], + 'DepartmentName' => ['title' => '', 'description' => 'The department name.', 'type' => 'string', 'example' => '加油组'], + 'EffectiveInCalls' => ['title' => '', 'description' => 'The number of effective inbound calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'EffectiveInServiceNotes' => ['title' => '', 'description' => 'The subtotal of effective inbound calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '9'], + 'EffectiveOutCalls' => ['title' => '', 'description' => 'The number of effective outbound calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'EffectiveOutServiceNotes' => ['title' => '', 'description' => 'The subtotal of effective outbound calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'QueryHotlineDashboard', + 'changeSet' => [ + ['createdAt' => '2021-12-16T13:32:40.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryHotlineDashboard'], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n123456\\nSuccess\\ntrue","errorExample":""}]', + 'ramActions' => [], ], - 'CreateSubTicket' => [ - 'summary' => '创建工单', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryHotlineSession' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7583,496 +5806,550 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CreatorId', + 'name' => 'Acid', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'docRequired' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CallType', 'in' => 'query', 'schema' => [ 'type' => 'integer', - 'format' => 'int64', - 'required' => true, + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'default' => '', + 'enum' => ['1', '2'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CreatorName', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'FromInfo', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'default' => '', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'FormData', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MemberId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'MemberName', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Priority', + 'name' => 'QueryEndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ParentCaseId', + 'name' => 'QueryStartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'BizData', + 'name' => 'RequestId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AgentId', + 'name' => 'ServicerName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ServicerId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CallResult', 'in' => 'query', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'string', + 'required' => false, + 'enum' => ['normal', 'touchRouteError', 'touchInQueue', 'touchInLoss', 'userHangup', 'sysHangup', 'transferAgent', 'dailing', 'TouchRingCallLoss'], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CallDetailRecord' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallResult' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OutQueueTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CallContinueTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PickUpTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RingContinueTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CalledNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HangUpTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EvaluationLevel' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'HangUpRole' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EvaluationScore' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Acid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RingStartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CallType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RingEndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CallingNumber' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InQueueTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'QueueUpContinueTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => null, - ], - 'CreateThirdSsoAgent' => [ - 'summary' => '创建坐席并开通sso登录能力', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0,\\n \\"TotalCount\\": 0,\\n \\"CallDetailRecord\\": [\\n {\\n \\"CallResult\\": \\"\\",\\n \\"ServicerName\\": \\"\\",\\n \\"OutQueueTime\\": \\"\\",\\n \\"CallContinueTime\\": 0,\\n \\"CreateTime\\": \\"\\",\\n \\"PickUpTime\\": \\"\\",\\n \\"RingContinueTime\\": 0,\\n \\"CalledNumber\\": \\"\\",\\n \\"ServicerId\\": \\"\\",\\n \\"HangUpTime\\": \\"\\",\\n \\"EvaluationLevel\\": 0,\\n \\"HangUpRole\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"EvaluationScore\\": 0,\\n \\"Acid\\": \\"\\",\\n \\"RingStartTime\\": \\"\\",\\n \\"CallType\\": 0,\\n \\"GroupId\\": 0,\\n \\"GroupName\\": \\"\\",\\n \\"RingEndTime\\": \\"\\",\\n \\"CallingNumber\\": \\"\\",\\n \\"InQueueTime\\": \\"\\",\\n \\"MemberId\\": \\"\\",\\n \\"QueueUpContinueTime\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'QueryRelationTickets' => [ + 'summary' => 'Queries related tickets.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'clientToken', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'CaseId', 'in' => 'formData', - 'schema' => [ - 'title' => 'param1', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_pre***', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ClientId', + 'name' => 'CaseType', 'in' => 'formData', - 'schema' => [ - 'title' => 'param2', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountId', + 'name' => 'SrType', 'in' => 'formData', - 'schema' => [ - 'title' => 'param3', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'accountId1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'TaskStatus', 'in' => 'formData', - 'schema' => [ - 'title' => 'param4', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'accountName1', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DisplayName', + 'name' => 'ChannelId', 'in' => 'formData', - 'schema' => [ - 'title' => 'param5', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'SkillGroupIds', + 'name' => 'ChannelType', 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'title' => 'param6', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'RoleIds', + 'name' => 'TouchId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DealId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Extra', 'in' => 'formData', 'style' => 'flat', - 'schema' => [ - 'title' => 'param7', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], + 'schema' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StartCaseGmtCreate', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndCaseGmtCreate', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', - 'description' => 'result', + 'title' => '', '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', - ], + 'RequestId' => ['title' => '', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'CurrentPage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CnePageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'FirstResult' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TotalResults' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'TotalPage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'NextPage' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'title' => '新创建的坐席id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Code' => [ - 'title' => 'code', - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'title' => 'success', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseGmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GaseGmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'SrType' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Owner' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ExtAttrs' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OwnerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RefCaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseDepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseBuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'FormId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CreatorId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DealId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Title' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DealTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DeadLine' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'AssignTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'UserServiceId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TemplateId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'FromInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServiceType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ParentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RelationCase' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseGmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseGmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Owner' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ExtAttrs' => ['type' => 'object', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionInfoQuestionInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'QuestionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'OwnerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RefCaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseDepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseBuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'FormId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CreatorId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DealId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Title' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DealTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DeadLine' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'AssignTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'UserServiceId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TemplateId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'FromInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServiceType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ParentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'CaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], ], ], - '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.', - ], + 'changeSet' => [ + ['createdAt' => '2021-09-22T15:19:30.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRelationTickets'], ], ], - '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":"\\n xxx\\n EE338D98-9BD3-4413-B165\\n 200\\n 123456\\n Success\\n true\\n","errorExample":""}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": false,\\n \\"CurrentPage\\": 0,\\n \\"CnePageSize\\": 0,\\n \\"FirstResult\\": 0,\\n \\"TotalResults\\": 0,\\n \\"TotalPage\\": 0,\\n \\"NextPage\\": 0,\\n \\"Data\\": [\\n {\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"CaseGmtCreate\\": 0,\\n \\"GaseGmtModified\\": 0,\\n \\"CaseType\\": 0,\\n \\"SrType\\": 0,\\n \\"Owner\\": 0,\\n \\"CaseStatus\\": 0,\\n \\"ChannelId\\": \\"\\",\\n \\"MemberId\\": 0,\\n \\"ExtAttrs\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ChannelType\\": 0,\\n \\"QuestionInfo\\": \\"\\",\\n \\"QuestionId\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"RefCaseId\\": 0,\\n \\"CaseDepartmentId\\": 0,\\n \\"CaseBuId\\": 0,\\n \\"FormId\\": 0,\\n \\"TaskStatus\\": 0,\\n \\"CreatorId\\": 0,\\n \\"DealId\\": 0,\\n \\"GroupId\\": 0,\\n \\"Priority\\": 0,\\n \\"Title\\": \\"\\",\\n \\"DealTime\\": 0,\\n \\"DeadLine\\": 0,\\n \\"TaskType\\": 0,\\n \\"AssignTime\\": 0,\\n \\"UserServiceId\\": 0,\\n \\"GroupName\\": \\"\\",\\n \\"BuId\\": 0,\\n \\"DepartmentId\\": 0,\\n \\"TemplateId\\": 0,\\n \\"FromInfo\\": \\"\\",\\n \\"ServiceType\\": 0,\\n \\"ParentId\\": 0,\\n \\"CaseId\\": 0,\\n \\"TaskId\\": 0,\\n \\"RelationCase\\": [\\n {\\n \\"GmtCreate\\": 0,\\n \\"GmtModified\\": 0,\\n \\"CaseGmtCreate\\": 0,\\n \\"CaseGmtModified\\": 0,\\n \\"CaseType\\": 0,\\n \\"Owner\\": 0,\\n \\"CaseStatus\\": 0,\\n \\"ChannelId\\": \\"\\",\\n \\"MemberId\\": 0,\\n \\"ExtAttrs\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ChannelType\\": 0,\\n \\"QuestionInfoQuestionInfo\\": \\"\\",\\n \\"QuestionId\\": \\"\\",\\n \\"OwnerName\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"RefCaseId\\": 0,\\n \\"CaseDepartmentId\\": 0,\\n \\"CaseBuId\\": 0,\\n \\"FormId\\": 0,\\n \\"TaskStatus\\": 0,\\n \\"CreatorId\\": 0,\\n \\"DealId\\": 0,\\n \\"GroupId\\": 0,\\n \\"Priority\\": 0,\\n \\"Title\\": \\"\\",\\n \\"DealTime\\": 0,\\n \\"DeadLine\\": 0,\\n \\"TaskType\\": 0,\\n \\"AssignTime\\": 0,\\n \\"UserServiceId\\": 0,\\n \\"GroupName\\": \\"\\",\\n \\"BuId\\": 0,\\n \\"DepartmentId\\": 0,\\n \\"TemplateId\\": 0,\\n \\"FromInfo\\": \\"\\",\\n \\"ServiceType\\": 0,\\n \\"ParentId\\": 0,\\n \\"CaseId\\": 0,\\n \\"TaskId\\": 0\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => '', ], - 'createTicketWithBizData' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryRingDetailList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '20', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageNo', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'StartDate', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '30401', - ], + 'schema' => ['description' => 'The start timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1614824872', 'title' => ''], ], [ - 'name' => 'CategoryId', + 'name' => 'EndDate', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '397001', - ], + 'schema' => ['description' => 'The end timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '1614824972', 'title' => ''], ], [ - 'name' => 'CreatorId', + 'name' => 'CallOutStatus', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '555555', - ], + 'schema' => ['description' => 'The updated callback status. Valid values:'."\n" + ."\n" + .'0: not called back.'."\n" + .'1: no answer.'."\n" + .'2: requires another callback.'."\n" + .'3: invalid number.'."\n" + .'4: callback succeeded.'."\n" + .'5: no callback required.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], ], [ - 'name' => 'CreatorType', + 'name' => 'Extra', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '4', - ], + 'schema' => ['description' => 'The extended field. The value is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{\\"isCallBack\\":\\"true\\"}', 'title' => ''], ], [ - 'name' => 'CreatorName', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'schema' => ['description' => 'The ID of the AICCS instance. You can find the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'MemberId', + 'name' => 'FromPhoneNumList', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '-1', - ], + 'style' => 'json', + 'schema' => ['description' => 'The list of caller numbers, such as user mobile numbers, agent numbers, or robot numbers.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'MemberName', + 'name' => 'ToPhoneNumList', 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The list of callee numbers, such as user mobile numbers, agent numbers, or robot numbers.', 'type' => 'object', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The call loss data.', '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" }', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query call loss data', + 'summary' => 'Queries call loss data.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'QueryServiceConfig' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FromInfo', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'manual', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '3', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CarbonCopy', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '234432', - ], + 'name' => 'ViewCode', + 'in' => 'query', + 'schema' => ['description' => 'The view code. Valid values:'."\n" + .'- serviceContextViewChatStand: online service'."\n" + .'- serviceContextViewHotlineStand: hotline service.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serviceContextViewChatStand', 'title' => ''], ], [ - 'name' => 'FormData', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], - ], - [ - 'name' => 'BizData', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'Parameters', + 'in' => 'query', + 'schema' => ['description' => 'The supplementary parameters. The value is a JSON string.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"memberId":64007246863,"channelType":2,"channelId":"3a184074ee34426795f3986d306b2689"},"sdkInstance":"9JKPvcl8xaN2"}', 'title' => ''], ], ], 'responses' => [ @@ -8081,3976 +6358,402 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The service summary information.', 'type' => 'string', 'example' => '{"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"}', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + 202 => [ + ['errorCode' => 'GetTenantIdFailed', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], + ], + [ + ['errorCode' => 'callRnderFailed', 'errorMessage' => 'Failed to call the viewRenderService.Render operation.', 'description' => ''], ], 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.', - ], + ['errorCode' => 'InstanceIdCannotBeNull', 'errorMessage' => 'You must specify InstanceId.', 'description' => ''], + ['errorCode' => 'ViewCodeNotNull', 'errorMessage' => 'You must specify ViewCode.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n2500000010\\nSuccess\\ntrue","errorExample":""}]', - ], - 'DeleteEntityRoute' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query service configuration', + 'summary' => 'Retrieves service summary information based on a view code.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryServicerByDepartmentAndMixName' => [ + 'summary' => 'Paged query of agent information by department and keyword ', + 'methods' => ['post'], + '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' => 'query', + 'schema' => ['title' => 'AICCS instance ID, which can be found in the Artificial Intelligence Cloud Call Service console ', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', 'description' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', + 'name' => 'DepartmentIdList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'title' => 'Department identity list ', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'example' => '905', 'description' => '', 'title' => ''], + 'description' => '', + 'example' => '', ], ], + [ + 'name' => 'KeyWord', + 'in' => 'query', + 'schema' => ['title' => 'Keyword ', 'type' => 'string', 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CurrentPageNum', + 'in' => 'query', + 'schema' => ['title' => 'Page number ', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => 'Page size ', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'description' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response ', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'RequestId' => ['title' => 'Id of the request ', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ServicerId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RealName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'UserStatus' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ShowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AccountName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - ], + 'changeSet' => [ + ['createdAt' => '2021-12-16T13:32:40.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryServicerByDepartmentAndMixName'], ], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"Total\\": 0,\\n \\"Results\\": [\\n {\\n \\"ServicerId\\": 0,\\n \\"RealName\\": \\"\\",\\n \\"UserStatus\\": 0,\\n \\"ShowName\\": \\"\\",\\n \\"AccountName\\": \\"\\",\\n \\"DepartmentId\\": 0,\\n \\"DepartmentName\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => '', ], - 'EditEntityRoute' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryServicerById' => [ + 'summary' => 'Query detailed agent information by agent identity', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['title' => 'AICCS instance ID, which can be found in the Artificial Intelligence Cloud Call Service console', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***', 'description' => ''], ], [ - 'name' => 'EntityName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ServicerId', + 'in' => 'query', + 'schema' => ['title' => 'Agent identity', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'description' => '', 'example' => ''], ], - [ - 'name' => 'EntityBizCode', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'title' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['title' => 'Status code', 'type' => 'string', 'description' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'ServicerId' => ['title' => 'Agent identity', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'RealName' => ['title' => 'Real name', 'type' => 'string', 'description' => '', 'example' => ''], + 'UserStatus' => ['title' => 'User status: 0 Normal, 1 freeze, 2 delete, -2 temporary freeze', 'type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => ''], + 'ShowName' => ['title' => 'Public display name', 'type' => 'string', 'description' => '', 'example' => ''], + 'AccountName' => ['title' => 'Logon name', 'type' => 'string', 'description' => '', 'example' => ''], + 'DepartmentId' => ['title' => 'Department identity', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'example' => '', ], ], + ], + 'changeSet' => [ + ['createdAt' => '2021-12-16T13:32:40.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryServicerById'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ServicerId\\": 0,\\n \\"RealName\\": \\"\\",\\n \\"UserStatus\\": 0,\\n \\"ShowName\\": \\"\\",\\n \\"AccountName\\": \\"\\",\\n \\"DepartmentId\\": 0\\n }\\n}","type":"json"}]', + 'title' => '', + ], + 'QuerySkillGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EntityBizCodeType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EntityRelationNumber', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'DepartmentId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '20', 'title' => ''], ], [ - 'name' => 'ServiceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique token for the client request. This token is used for idempotence checks. You can use a UUID to generate the token.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ExtInfo', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the skill group.', 'type' => 'string', 'required' => false, 'example' => '自动化技能组', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'GroupType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the skill group. Valid values:'."\n" + .'1: hotline'."\n" + .'2: online'."\n" + .'4: ticket.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '2', 'title' => ''], ], [ - 'name' => 'UniqueId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - ], + 'name' => 'GroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'OnePageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'CurrentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalResults' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '76', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data information.', + 'type' => 'object', + 'properties' => [ + 'DisplayName' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'Description' => ['description' => 'The description of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'ChannelType' => ['description' => 'The channel type of the skill group.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'SkillGroupName' => ['description' => 'The name of the skill group.', 'type' => 'string', 'example' => '自动化技能组', 'title' => ''], + 'SkillGroupId' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - ], + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'FetchCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query skill groups', + 'summary' => 'Queries the skill group list in the Cloud Customer Service System by skill group channel type, skill group name, or skill group ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryTicketActions' => [ + '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' => '123@123.com', - ], - ], - [ - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\ndnthF_oinHg7JMJDmKqex3UxDD7\\nSuccess\\ntrue","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":"phoneNum and havePhoneNum must be either empty or not empty at the same time\\n45FAB8AB-CFB3-4582-B1A5-9010DEADD8F9\\nInvalidPhone\\ntrue\\n\\n 13\\n 10\\n 1\\n \\n -1\\n -1\\n 0\\n 50\\n 1583709xxxx\\n 1\\n 1\\n -1\\n \\n","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":"xxxx\\nEE339D98-9BD3-4413-B165\\n\\n 1\\n 1\\n xxxx\\n male\\n zhangsan\\n zhangsan\\n 张三\\n false\\n 131111111111\\n\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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":"xxxx\\nEE338D98-9BD3-4413-B165\\n杭州\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n \\n 2\\n Jella\\n 76\\n \\n \\n 1\\n 9065446\\n 浙江省杭州市\\n \\n\\nSuccess\\ntrue","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":"xxxx\\nEE338D98-9BD3-4413-B165\\n{\\\\\\"buId\\\\\\":{\\\\\\"title\\\\\\":\\\\\\"租户编码\\\\\\",\\\\\\"type\\\\\\":\\\\\\"string\\\\\\"},\\\\\\"sopCateId\\\\\\":{\\\\\\"title\\\\\\":\\\\\\"业务类目\\\\\\"}\\nSuccess\\ntrue","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":"xxxx\\nEE338D98-9BD3-4413-xxxx\\n\\n 1614528000000\\n xxx-xxx-xxxx\\n\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - [ - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - [ - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - [ - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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' => '123@123.com', - ], - ], - [ - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","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":"xxxx\\nEE338D98-9BD3-4413-B165\\n\\n 自动化技能组\\n 自动化技能组\\n 2\\n 123456\\n 自动化技能组\\n\\nSuccess\\ntrue","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\\"}', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'FromPhoneNumList', + 'name' => 'TicketId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ToPhoneNumList', + 'name' => 'ActionCodeList', 'in' => 'formData', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'object', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, + 'maxItems' => 100, + 'description' => '', + 'title' => '', + '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' => '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n{\\"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\\" }\\nSuccess\\ntrue","errorExample":""}]', - ], - 'QueryServiceConfig' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'QueryTicketCount' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ViewCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'serviceContextViewChatStand', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'Parameters', + 'name' => 'OperatorId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"memberId":64007246863,"channelType":2,"channelId":"3a184074ee34426795f3986d306b2689"},"sdkInstance":"9JKPvcl8xaN2"}', - ], + 'schema' => ['description' => 'The ID of the operator.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '666666', 'title' => ''], ], ], 'responses' => [ @@ -12059,262 +6762,177 @@ '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The total number of tickets being processed.', 'type' => 'string', 'example' => '45', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 202 => [ - [ - 'errorCode' => 'GetTenantIdFailed', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - [ - [ - 'errorCode' => 'callRnderFailed', - 'errorMessage' => 'Failed to call the viewRenderService.Render operation.', - ], + ['errorCode' => 'GetTenantIdFailed', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], 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.', - ], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n{\\"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\\"}\\nSuccess\\ntrue","errorExample":""}]', - ], - 'QuerySkillGroups' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"45\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query ticket count', + 'summary' => 'Queries the total number of tickets being processed by a specified operator ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryTickets' => [ + 'summary' => 'Queries a ticket.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '20', - ], + 'name' => 'CaseType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'CaseStatus', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1000', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'SrType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '2', - ], + 'name' => 'TaskStatus', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'example' => '123456', - ], + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], - ], - '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', - ], - ], - ], - ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TouchId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DealId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['type' => 'object', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MemberId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ParentCaseId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StartCaseGmtCreate', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndCaseGmtCreate', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5000', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', 'description' => ''], ], ], - '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":"20\\n4\\nEE338D98-9BD3-4413-B165\\n1\\n76\\n\\n 自动化技能组\\n 自动化技能组\\n 2\\n 自动化技能组\\n 123456\\n","errorExample":""}]', - ], - 'RemoveSkillGroup' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-09-22T15:19:30.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + ], + 'RemoveSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12327,34 +6945,17 @@ [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'SkillGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The ID of the skill group.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123456', 'title' => ''], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'A unique client request ID for idempotence. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], ], 'responses' => [ @@ -12363,213 +6964,221 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'SendOutboundCommand' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a skill group', + 'summary' => 'Deletes a skill group from the Cloud Customer Service System by skill group ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SearchTicketById' => [ + 'summary' => 'Queries the details of a ticket by ticket ID.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID, used for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'CallingNumber', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'default' => '-1', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can find this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CalledNumber', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'TicketId', + 'in' => 'query', + 'schema' => ['description' => 'The ticket ID (ticket number).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2500000010', 'title' => ''], ], [ - 'name' => 'CustomerInfo', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The status code of the ticket.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '12001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used to trace the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'description' => 'The ticket details.', + 'type' => 'object', + 'properties' => [ + 'CarbonCopy' => ['description' => 'The carbon copy recipient.', 'type' => 'string', 'example' => '234432', 'title' => ''], + 'MemberName' => ['description' => 'The member name.', 'type' => 'string', 'example' => '匿名会员', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'ServiceId' => ['description' => 'The ID of the customer service representative or agent (the ID of the ticket operator).', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'TicketId' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2500000010', 'title' => ''], + 'Priority' => ['description' => 'The priority of the ticket.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the creator.', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'FormData' => ['description' => 'The business information of the ticket (ticket template form information).', 'type' => 'string', 'example' => '{"questionInfo":"自动化创建工单"}', 'title' => ''], + 'Activities' => [ + 'description' => 'The activity business information of the ticket (ticket activity form information).', + 'type' => 'array', + 'items' => [ + 'description' => 'The ticket activity form information.', + 'type' => 'object', + 'properties' => [ + 'ActivityFormData' => ['description' => 'The encoded ticket activity form information.', 'type' => 'string', 'example' => '{\\"BQ73dGsSNs\\":\\"备注\\"}', 'title' => ''], + 'ActivityCode' => ['description' => 'The activity code.', 'type' => 'string', 'example' => 'finish', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ActivityRecords' => [ + 'description' => 'The action records.', + 'type' => 'array', + 'items' => [ + 'description' => 'The action record information.', + 'type' => 'object', + 'properties' => [ + 'ActionCode' => ['description' => 'The activity code of the action record.', 'type' => 'string', 'example' => '997015', 'title' => ''], + 'ActionCodeDesc' => ['description' => 'The name of the activity code of the action record.', 'type' => 'string', 'example' => '创建工单', 'title' => ''], + 'OperatorName' => ['description' => 'The name of the ticket operator.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'Operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Memo' => ['description' => 'The action remarks.', 'type' => 'string', 'example' => '{"CFQyYAPjKb":"开胶"}', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the operation was performed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824772', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'FromInfo' => ['description' => 'The creation source.', 'type' => 'string', 'example' => 'hotline', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the ticket was processed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'CategoryId' => ['description' => 'The ID of the business category.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CreatorType' => ['description' => 'The role of the creator. Valid values:'."\n" + .'- 0: system.'."\n" + .'- 1: member.'."\n" + .'- 4: customer service representative.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MemberId' => ['description' => 'The member ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1876543', 'title' => ''], + 'CaseStatus' => ['description' => 'The ticket status (numeric value of the ticket status).', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'TemplateId' => ['description' => 'The ticket template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '546754', 'title' => ''], + 'TicketName' => ['description' => 'The ticket name.', 'type' => 'string', 'example' => '自动化工单', 'title' => ''], + 'ParentCaseId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'StartCall' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query ticket by ID', + 'changeSet' => [ + ['createdAt' => '2022-03-03T09:32:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SearchTicketByPhone' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'name' => 'Phone', + 'in' => 'query', + 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '138999', 'title' => ''], ], [ - 'name' => 'Caller', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9065446', - ], + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '546754', 'title' => ''], ], [ - 'name' => 'Callee', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '136098792', - ], + 'name' => 'TicketStatus', + 'in' => 'query', + 'schema' => ['description' => 'The ticket status.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '6', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1614824872', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1614825972', 'title' => ''], ], ], 'responses' => [ @@ -12578,129 +7187,121 @@ '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', + 'OnePageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. It is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalResults' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '16', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The ticket information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ticket information.', + 'type' => 'object', + 'properties' => [ + 'MemberName' => ['description' => 'The name of the member.', 'type' => 'string', 'example' => '匿名会员', 'title' => ''], + 'CarbonCopy' => ['description' => 'The carbon copy recipient.', 'type' => 'string', 'example' => '234432', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'ServiceId' => ['description' => 'The ID of the customer service representative or agent who operated the ticket.', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'TicketId' => ['description' => 'The ticket ID (ticket code).', 'type' => 'integer', 'format' => 'int64', 'example' => '2500000010', 'title' => ''], + 'Priority' => ['description' => 'The priority of the ticket.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the creator.', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'FormData' => ['description' => 'The business information of the ticket (ticket template form data).', 'type' => 'string', 'example' => '{"questionInfo":"自动化创建工单"}', 'title' => ''], + 'FromInfo' => ['description' => 'The source from which the ticket was created.', 'type' => 'string', 'example' => 'hotline', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the ticket was processed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'TaskStatus' => ['description' => 'The ticket status. Valid values: Unprocessed, Processing, Completed, Suspended, Canceled, and Pending Assignment.', 'type' => 'string', 'example' => '处理中', 'title' => ''], + 'CreatorName' => ['description' => 'The name of the creator.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'CategoryId' => ['description' => 'The ID of the business category.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CreatorType' => ['description' => 'The role of the creator. Valid values: 0: system. 1: member. 4: customer service representative.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MemberId' => ['description' => 'The ID of the member.', 'type' => 'integer', 'format' => 'int64', 'example' => '1876543', 'title' => ''], + 'CaseStatus' => ['description' => 'The ticket status (numeric value).', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the ticket template.', 'type' => 'integer', 'format' => 'int64', 'example' => '546754', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'StartCallV2' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query tickets by phone number', + 'summary' => 'Queries ticket information by phone number.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SearchTicketList' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'name' => 'OperatorId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the ticket operator.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '555555', 'title' => ''], + ], + [ + 'name' => 'TicketStatus', + 'in' => 'query', + 'schema' => ['description' => 'The ticket status (status value).'."\n" + .'**Note: You must customize the status value when defining the ticket type. For example, you must manually change the status value for "pending delivery" to 3807 and complete this change before creating the ticket for the query condition to take effect. See the following image (copy the link and download to view):**'."\n" + .'https://cdn.nlark.com/yuque/0/2020/png/2733660/1608724297862-da5150ed-71f0-47a5-8de4-c371cda23b97.png.', 'type' => 'string', 'required' => false, 'example' => '6', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Caller', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9065446', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '20', 'example' => '20', 'title' => ''], ], [ - 'name' => 'Callee', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '136098792', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1614824872', 'title' => ''], ], [ - 'name' => 'JsonMsg', - 'in' => 'formData', - 'schema' => [ - 'description' => 'JsonMsg', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '1614825972', 'title' => ''], ], ], 'responses' => [ @@ -12709,501 +7310,417 @@ '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', + 'OnePageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'TotalResults' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '45', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Data' => [ + 'description' => 'The ticket information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The ticket information.', + 'type' => 'object', + 'properties' => [ + 'MemberName' => ['description' => 'The member name.', 'type' => 'string', 'example' => '匿名会员', 'title' => ''], + 'CarbonCopy' => ['description' => 'The carbon copy recipient.', 'type' => 'string', 'example' => '234432', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the ticket was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'ServiceId' => ['description' => 'The service ID (ticket operator ID).', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'TicketId' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2500000010', 'title' => ''], + 'Priority' => ['description' => 'The ticket priority.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CreatorId' => ['description' => 'The creator ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '555555', 'title' => ''], + 'FormData' => ['description' => 'The ticket business information (ticket template form data).', 'type' => 'string', 'example' => '{"questionInfo":"自动化创建工单"}', 'title' => ''], + 'FromInfo' => ['description' => 'The creation source.', 'type' => 'string', 'example' => 'hotline', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the ticket was processed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1614824872', 'title' => ''], + 'TaskStatus' => ['description' => 'The ticket status. Valid values: unprocessed, processing, completed, suspended, canceled, and pending assignment.', 'type' => 'string', 'example' => '处理中', 'title' => ''], + 'CreatorName' => ['description' => 'The creator name.', 'type' => 'string', 'example' => '刘测试', 'title' => ''], + 'CategoryId' => ['description' => 'The business category ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CreatorType' => ['description' => 'The creator role. Valid values:'."\n" + .'- 0: system.'."\n" + .'- 1: member.'."\n" + .'- 4: customer service representative.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'MemberId' => ['description' => 'The member ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1876543', 'title' => ''], + 'CaseStatus' => ['description' => 'The ticket status.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'TemplateId' => ['description' => 'The ticket template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '546754', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'StartChatWork' => [ - 'summary' => '修改在线客服为上班状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'Query ticket list', + 'summary' => 'Queries ticket list information based on the ticket operator ID.', + 'responseParamsDescription' => '1) By default, tickets are sorted in reverse chronological order by creation time, with the most recent tickets listed first.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SendHotlineHeartBeat' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'instanceId', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xspace***', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view this on the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'title' => 'accountName', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'account1', - ], + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => ['description' => 'The heartbeat signature.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0079e7a845e37334ff', 'title' => ''], ], ], '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"\\n xxx\\n EE338D98-9BD3-4413-xxxx\\n 200\\n 1\\n Agent.NotFound\\n true\\n","errorExample":""}]', - ], - 'UpdateCustomer' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Send hotline heartbeat', + 'summary' => 'Sends a hotline heartbeat.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SendOutboundCommand' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', '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' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Phone', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1560000xxxx', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'CallingNumber', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'default' => '-1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ManagerName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'CalledNumber', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Contacter', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'name' => 'CustomerInfo', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'Industry', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', 'example' => '', ], ], - [ - 'name' => 'Position', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], + ], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'SendVerificationCode' => [ + 'summary' => 'Sends a verification code SMS to the phone number bound to an agent.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123@123.com', - ], + 'AK' => [], ], [ - 'name' => 'Dingding', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123yiyo', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'OuterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10000011', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique client request ID used for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'], ], [ - 'name' => 'OuterIdType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ - 'name' => 'CustomerId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '24027', - ], + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The phone number bound to the agent.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136********'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'title' => '', + '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', - ], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'NoTenantFound', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'UpdateEntityTagRelation' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","type":"json"}]', + 'title' => 'Send verification code SMS', + 'description' => 'Verification code sending time window: 2 minutes (a number cannot receive duplicate codes within 2 minutes).'."\n" + .'Verification code validity period: 15 minutes.'."\n" + .'Sending frequency limit: The same phone number cannot receive more than 20 verification codes within 6 hours.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartAgentMonitor' => [ + 'summary' => 'Initiate agent listener', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'EntityTagParam', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'maxLength' => 9.223372036854776E+18, - 'minLength' => -1, - 'default' => '20', - ], + 'name' => 'CallerParentId', + 'in' => 'query', + 'schema' => ['title' => 'callerParentId', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['title' => 'requestId', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['title' => 'clientToken', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallerType', + 'in' => 'query', + 'schema' => ['title' => 'callerType', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallerUid', + 'in' => 'query', + 'schema' => ['title' => 'callerUid', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'StsTokenCallerUid', + 'in' => 'query', + 'schema' => ['title' => 'stsTokenCallerUid', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'example' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'in' => 'query', + 'schema' => ['title' => 'param1', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['title' => 'param2', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['title' => 'param4', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['title' => 'param5', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => ['title' => 'param6', 'type' => 'string', 'required' => false, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['title' => 'message', 'type' => 'string', 'description' => '', 'example' => ''], + 'RequestId' => ['title' => 'requestId', 'type' => 'string', 'description' => '', 'example' => ''], + 'Code' => ['title' => 'code', 'type' => 'string', 'description' => '', 'example' => ''], + 'Success' => ['title' => 'success', 'type' => 'boolean', 'description' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InvalidParameter', - 'errorMessage' => 'The specified parameter is invalid.', - ], + 'changeSet' => [ + ['createdAt' => '2022-01-12T02:42:18.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAgentMonitor'], ], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', ], - 'UpdateRingStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'UniqueBizId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '78604', - ], + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'CallOutStatus', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'Extra', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{\\"isCallBack\\":\\"true\\"}', - ], + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Caller', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The caller number for the outbound call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9065446', 'title' => ''], + ], + [ + 'name' => 'Callee', + 'in' => 'formData', + 'schema' => ['description' => 'The callee number for the outbound call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136098792', 'title' => ''], ], ], 'responses' => [ @@ -13212,49 +7729,34 @@ '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\n{\\"BizId\\": \\"78604\\"}\\nSuccess\\ntrue","errorExample":""}]', - ], - 'UpdateRole' => [ - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Initiate an outbound call', + 'summary' => 'Initiates an outbound call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartCallV2' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13263,207 +7765,159 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'RoleId', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'RoleName', + 'name' => 'Caller', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The caller number for the outbound call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9065446', 'title' => ''], ], [ - 'name' => 'Operator', + 'name' => 'Callee', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The callee number for the outbound call.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '136098792', 'title' => ''], ], [ - 'name' => 'PermissionId', + 'name' => 'JsonMsg', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'schema' => ['description' => 'The JSON message.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"外呼原因":"工单处理"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => null, - ], - 'UpdateSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Initiate an outbound call', + 'summary' => 'Initiates an outbound call V2.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartChatWork' => [ + 'summary' => 'Changes the status of an online customer service representative to on-duty.', + 'methods' => ['post'], + '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-***', - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The instance ID.', 'type' => 'string', 'required' => true, 'example' => 'ccc_xspace***'], ], [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123456', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The account name of the agent, which is unique within the instance (logon name).', 'type' => 'string', 'required' => true, 'example' => 'account1'], ], - [ - 'name' => 'SkillGroupName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'xxx'], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-xxxx'], + 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['title' => '', 'description' => 'The call result.', 'type' => 'string', 'example' => '1'], + 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'Agent.NotFound'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true'], + ], 'example' => '', ], ], + ], + '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.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-xxxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"Agent.NotFound\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Set online customer service representative to on-duty', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartChatWork'], + ], + ], + 'ramActions' => [], + ], + 'StartHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'AK' => [], + ], + [ + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update'], + 'parameters' => [ [ - 'name' => 'DisplayName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotence checks. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'ChannelType', - 'in' => 'query', - 'schema' => [ - 'title' => '渠道类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The account name of the agent (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], ], 'responses' => [ @@ -13472,53 +7926,39 @@ '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The token required to initiate heartbeat detection. This parameter is returned when the request is successful.', 'type' => 'string', 'example' => '0079e7a845e37334ff', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidInstanceId', - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - ], + 500 => [ + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"xxxx\\nEE338D98-9BD3-4413-B165\\nSuccess\\ntrue","errorExample":""}]', - ], - 'ListAllHotLineSkillGroups' => [ - 'summary' => '查询某个租户下所有热线类型技能组及技能组分类', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"0079e7a845e37334ff\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Start hotline service', + 'summary' => 'Signs in an agent to start the hotline service.', + 'changeSet' => [ + ['createdAt' => '2021-04-27T10:02:25.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartHotlineWork' => [ + 'summary' => 'Hotline Agent Sign-in', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13527,146 +7967,88 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['title' => 'Unique customer request ID used for idempotency validation; can be generated using UUID', 'type' => 'string', 'description' => '', 'example' => ''], + ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'in' => 'formData', + 'schema' => ['title' => 'AICCS instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], [ 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'in' => 'formData', + 'schema' => ['title' => 'Agent Account Name (Unique value), mapping between external account and XP account logon name ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'WorkChannel', + 'in' => 'formData', + 'schema' => ['title' => 'Work Channel, enumeration values: (Phone) PSTN; (PC) PC ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], + ], + [ + 'name' => 'SkillGroups', + 'in' => 'formData', + 'schema' => ['title' => 'Agent hotline skill groups, format: "[123,456,...,789]"', 'type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => 'Result', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], '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', - ], - ], - ], - ], - ], - ], - ], - ], + 'type' => 'object', + 'properties' => [ + 'TenantId' => ['title' => 'Tenant ID', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'AgentId' => ['title' => 'Agent ID', 'type' => 'integer', 'format' => 'int64', 'description' => '', 'example' => ''], + 'AccountName' => ['title' => 'Agent account name (agent logon name)', 'type' => 'string', 'description' => '', 'example' => ''], + 'AgentStatusCode' => ['title' => 'Agent sign-in status code', 'type' => 'string', 'description' => '', 'example' => ''], + 'AgentStatusDesc' => ['title' => 'Agent sign-in status description', 'type' => 'string', 'description' => '', 'example' => ''], + 'WorkChannel' => ['title' => 'Sign-in channel, such as PSTN phone or PC', 'type' => 'string', 'description' => '', 'example' => ''], + 'AgentToken' => ['title' => 'Frontend token', 'type' => 'string', 'description' => '', 'example' => ''], + 'ExtAttr' => ['title' => 'Extension field', 'type' => 'string', 'description' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - ], - 'AnwserAgentMonitor' => [ - 'summary' => '接通坐席监听', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-07-20T12:30:06.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": false,\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": {\\n \\"TenantId\\": 0,\\n \\"AgentId\\": 0,\\n \\"AccountName\\": \\"\\",\\n \\"AgentStatusCode\\": \\"\\",\\n \\"AgentStatusDesc\\": \\"\\",\\n \\"WorkChannel\\": \\"\\",\\n \\"AgentToken\\": \\"\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"RequestId\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + ], + 'SuspendHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13680,237 +8062,169 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CallerParentId', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerParentId', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the client request, which is used for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'title' => 'requestId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'CallerType', - 'in' => 'query', + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The reason for the break. Valid values:'."\n" + ."\n" + .'1: break (default)'."\n" + .'2: meal'."\n" + .'3: meeting'."\n" + .'4: coaching'."\n" + .'5: training.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '5', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'callerType', - 'type' => 'string', - 'required' => false, + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Pause hotline service', + 'summary' => 'Pauses the hotline service when an agent takes a break.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'TransferCallToAgent' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'AK' => [], ], [ - 'name' => 'StsTokenCallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'stsTokenCallerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID to generate the value.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => 'InstanceId', - 'type' => 'string', - 'required' => false, - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'title' => 'AccountName', - 'type' => 'string', - 'required' => false, - ], + 'in' => 'formData', + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'TargetAccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the target agent account (agent logon name) to which the call is transferred.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '345@123.com', 'title' => ''], ], [ 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CallId', - 'type' => 'string', - 'required' => false, - ], + 'in' => 'formData', + 'schema' => ['description' => 'The acid in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => 'JobId', - 'type' => 'string', - 'required' => false, - ], + 'in' => 'formData', + 'schema' => ['description' => 'The jobId in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], ], [ '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', - ], - ], - ], + 'in' => 'formData', + 'schema' => ['description' => 'The connId in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], - ], - ], - 'GetForeignIdByCMSId' => [ - 'summary' => '通过CMSId获取ForeignId', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId in the WebSocket message after an inbound call is received. This parameter is required only for two-step transfers.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''], ], - ], - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The transfer type. Valid values:'."\n" + .'- 1: single-step transfer'."\n" + .'- 2: two-step transfer'."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - ], + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use a single-step transfer. Valid values:'."\n" + .'- true: Single-step transfer.'."\n" + .'- false: Two-step transfer.'."\n" + .'Default value: true.', 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'description' => 'result', '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', - ], - ], - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - ], - 'HangUpAgentMonitor' => [ - 'summary' => '挂断坐席监听', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Forward hotline call to agent', + 'summary' => 'Transfers a call to an agent by using a single-step or two-step transfer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'TransferCallToPhone' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13924,144 +8238,116 @@ 'systemTags' => [], 'parameters' => [ [ - 'name' => 'CallerParentId', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerParentId', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The unique client request ID for idempotency verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'title' => 'requestId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the AICCS instance. You can view this ID in the Intelligent Contact Center console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'title' => 'clientToken', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'CallerType', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerType', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'Caller', + 'in' => 'formData', + 'schema' => ['description' => 'The caller number for the hotline transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '9065446', 'title' => ''], ], [ - 'name' => 'CallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'Callee', + 'in' => 'formData', + 'schema' => ['description' => 'The callee number for the hotline transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '136098792', 'title' => ''], ], [ - 'name' => 'StsTokenCallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'stsTokenCallerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => 'InstanceId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'title' => 'AccountName', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'title' => 'CallId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId from the WebSocket message after an inbound call is received. This parameter is required only for dual-step transfers.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => 'JobId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The transfer type. Valid values:'."\n" + .'- 1: single-step transfer'."\n" + .'- 2: dual-step transfer'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'ConnectionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'ConnectionId', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use single-step transfer. Valid values:'."\n" + .'- true: Single-step transfer.'."\n" + .'- false: Dual-step transfer.'."\n" + ."\n" + .'Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'callerPhone', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'calleePhone', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'type' => 'string', - ], - 'Code' => [ - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'title' => 'success', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - ], - 'StartAgentMonitor' => [ - 'summary' => '发起坐席监听', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Forward hotline to phone', + 'summary' => 'Transfers a call to a phone number using single-step or dual-step transfer.', + 'changeSet' => [ + ['createdAt' => '2021-05-18T14:52:14.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'TransferCallToSkillGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14074,145 +8360,97 @@ '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, - ], + 'in' => 'formData', + 'schema' => ['description' => 'The unique ID of the client request. This parameter is used for idempotence verification. You can use a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'CallerType', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerType', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can find the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'callerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'StsTokenCallerUid', - 'in' => 'query', - 'schema' => [ - 'title' => 'stsTokenCallerUid', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '356543', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => 'param1', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'title' => 'param2', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'title' => 'param4', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'title' => 'param5', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId from the WebSocket after an inbound call is received. This parameter is required only for double-step transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'ConnectionId', - 'in' => 'query', - 'schema' => [ - 'title' => 'param6', - 'type' => 'string', - 'required' => false, - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The transfer type. Valid values:'."\n" + .'- 1: single-step transfer.'."\n" + .'- 2: double-step transfer.'."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'IsSingleTransfer', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use single-step transfer. Valid values:'."\n" + .'- true: Single-step transfer.'."\n" + .'- false: Double-step transfer.'."\n" + .'Default value: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'result', + 'description' => 'result', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'title' => 'requestId', - 'type' => 'string', - ], - 'Code' => [ - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'title' => 'success', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - ], - 'BindAgentHotlinePhone' => [ - 'summary' => '绑定热线坐席手机号', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Transfer a hotline call to a skill group', + 'summary' => 'Transfers a call to a skill group by using single-step or double-step transfer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'TransferToThirdCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14221,128 +8459,82 @@ 'BearerToken' => [], ], ], - 'operationType' => 'write', + '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', - ], + 'schema' => ['description' => 'The unique ID of the client request, which is used for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号登录名的映射', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The name of the agent account (agent logon name).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com', 'title' => ''], ], [ - 'name' => 'Phone', + 'name' => 'CallId', 'in' => 'formData', - 'schema' => [ - 'title' => '手机号', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '136********', - ], + 'schema' => ['description' => 'The acid in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719786', 'title' => ''], ], [ - 'name' => 'VerifyCode', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'title' => '验证码', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123456', - ], + 'schema' => ['description' => 'The jobId in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719787', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId in the WebSocket message after an inbound call is received.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '7719788', 'title' => ''], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId in the WebSocket message after an inbound call is received. This parameter is required only for a two-step transfer.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', - 'description' => 'Result', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n NoTenantFound\\n xxxxx\\n EE338D98-9BD3-4413-B165\\n","errorExample":""}]', - ], - 'GetHotlineAgentDetailWithChannel' => [ - 'summary' => '同 GetHotlineAgentDetail，返回上班渠道', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Forward hotline', + 'summary' => 'Transfers a call to a third party in a single step.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UnbindAgentHotlinePhone' => [ + 'summary' => 'Clears the extended phone number information of an agent.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14351,128 +8543,60 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The unique client request ID, used for idempotence checks. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d'], ], [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The AICCS instance ID. You can view this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号登录名的映射', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The agent account name (unique value). This is the mapping between the external account and the XP account logon name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123@123.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Result', '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', - ], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The error code. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'NoTenantFound', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is empty when Success is true.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], ], + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], ], ], - ], - 'GetAgentHotlinePhone' => [ - 'summary' => '查询坐席绑定手机号', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","type":"json"}]', + 'title' => 'Unbind agent phone number', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateAgent' => [ + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14481,366 +8605,340 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'title' => '客户请求唯一id，用于幂等校验，可以用uuid生成', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 200, 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AccountName', + 'name' => 'SkillGroupIdList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号登录名的映射', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 200, 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', - 'description' => 'Result', '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ], + ], + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'UpdateCustomer' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'ProdLineId', + 'in' => 'query', + 'schema' => ['description' => 'The product line ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '10552599', 'title' => ''], + ], + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => ['description' => 'The business type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'xp_commerce_aliyun', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '张三', 'title' => ''], + ], + [ + 'name' => 'TypeCode', + 'in' => 'query', + 'schema' => ['description' => 'The customer type.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '1560000xxxx', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can find the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], + ], + [ + 'name' => 'ManagerName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the manager.', 'type' => 'string', 'required' => false, 'example' => '管理人', 'title' => ''], + ], + [ + 'name' => 'Contacter', + 'in' => 'query', + 'schema' => ['description' => 'The creator.', 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Industry', + 'in' => 'query', + 'schema' => ['description' => 'The industry.', 'type' => 'string', 'required' => false, 'example' => '服饰', 'title' => ''], + ], + [ + 'name' => 'Position', + 'in' => 'query', + 'schema' => ['description' => 'The position.', 'type' => 'string', 'required' => false, 'example' => '主管', 'title' => ''], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => 'The email address.', 'type' => 'string', 'required' => false, 'example' => '123@123.com', 'title' => ''], + ], + [ + 'name' => 'Dingding', + 'in' => 'query', + 'schema' => ['description' => 'The DingTalk account.', 'type' => 'string', 'required' => false, 'example' => '123yiyo', 'title' => ''], + ], + [ + 'name' => 'OuterId', + 'in' => 'query', + 'schema' => ['description' => 'The external ID.', 'type' => 'string', 'required' => false, 'example' => '10000011', 'title' => ''], + ], + [ + 'name' => 'OuterIdType', + 'in' => 'query', + 'schema' => ['description' => 'The external type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'CustomerId', + 'in' => 'query', + 'schema' => ['description' => 'The customer ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '24027', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'result', + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The customer data.', 'type' => 'integer', 'format' => 'int64', 'example' => '{"CustomerId":"24027"}', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - '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":"\\n true\\n NoTenantFound\\n xxxx\\n 136********\\n EE338D98-9BD3-4413-B165\\n","errorExample":""}]', - ], - 'GetAgentHotline' => [ - 'summary' => '查询热线坐席信息与热线技能组', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update customer information', + 'summary' => 'Updates a customer.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateEntityTagRelation' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'EntityTagParam', 'in' => 'formData', - 'schema' => [ - 'title' => '客户请求唯一id，用于幂等校验，可以用uuid生成', - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => false, 'maxLength' => 9.223372036854776E+18, 'minLength' => -1, 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], ], [ '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, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - ], - 'UnbindAgentHotlinePhone' => [ - 'summary' => '解绑热线坐席手机号', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'UpdateRingStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'UniqueBizId', 'in' => 'formData', - 'schema' => [ - 'title' => '客户请求唯一id，用于幂等校验，可以用uuid生成', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'The unique primary key of the data.', 'type' => 'string', 'required' => false, 'example' => '78604', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'CallOutStatus', 'in' => 'formData', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'The callback status to update. Valid values:'."\n" + ."\n" + .'0: not called back'."\n" + .'1: no answer'."\n" + .'2: requires another callback'."\n" + .'3: invalid number'."\n" + .'4: callback succeeded'."\n" + .'5: no callback needed.', 'type' => 'string', 'required' => false, 'example' => '4', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'Extra', 'in' => 'formData', - 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号登录名的映射', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', - ], + 'schema' => ['description' => 'The extension field. The value is a JSON string.', 'type' => 'string', 'required' => false, 'example' => '{\\"isCallBack\\":\\"true\\"}', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', - 'description' => 'Result', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The query result. The value is a JSON string.', 'type' => 'string', 'example' => '{"BizId": "78604"}', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - '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":"\\n true\\n NoTenantFound\\n xxxx\\n EE338D98-9BD3-4413-B165\\n","errorExample":""}]', - ], - 'GetAgentWorkStatus' => [ - 'summary' => '查询热线坐席上班状态', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"BizId\\\\\\": \\\\\\"78604\\\\\\"}\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Update outbound call status', + 'summary' => 'Updates the callback status.', + 'changeSet' => [ + ['createdAt' => '2021-04-14T08:50:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14849,807 +8947,599 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + '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', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'RoleId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'RoleName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PermissionId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号的映射', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 200, 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123@123.com', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', - 'description' => 'Result', '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' => '123@123.com', - ], - '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', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], '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.', - ], + ['errorCode' => 'NoAgentFound', 'errorMessage' => 'The specified agent does not exist.', 'description' => ''], + ['errorCode' => 'NoTenantFound', 'errorMessage' => 'The specified tenant does not exist.', 'description' => ''], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxxx\\",\\n \\"Data\\": {\\n \\"TenantId\\": 905,\\n \\"AgentId\\": 1059054,\\n \\"AccountName\\": \\"123@123.com\\",\\n \\"AgentStatusCode\\": \\"AgentCheckin\\",\\n \\"AgentStatusDesc\\": \\"坐席签入状态\\",\\n \\"WorkChannel\\": \\"PC\\",\\n \\"ExtAttr\\": \\"\\"\\n },\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n NoTenantFound\\n xxxxx\\n \\n 905\\n 1059054\\n 123@123.com\\n AgentCheckin\\n 坐席签入状态\\n PC\\n \\n EE338D98-9BD3-4413-B165\\n","errorExample":""}]', - ], - 'SendVerificationCode' => [ - 'summary' => '短信验证码发送', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"\\",\\n \\"HttpStatusCode\\": 0,\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'UpdateSkillGroup' => [ + 'methods' => ['post', 'get'], + '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' => 'query', + 'schema' => ['description' => 'The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the skill group.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123456', 'title' => ''], ], [ - 'name' => 'Phone', - 'in' => 'formData', - 'schema' => [ - 'title' => '手机号（坐席绑定手机号码）', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '136********', - ], + 'name' => 'SkillGroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the skill group.', 'type' => 'string', 'required' => false, 'example' => '自动化测试', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the skill group.', 'type' => 'string', 'required' => false, 'example' => '自动化测试', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => ['description' => 'The display name of the skill group.', 'type' => 'string', 'required' => false, 'example' => '自动化测试', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the client request, which is used for idempotence verification. You can use a UUID to generate the ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], + ], + [ + 'name' => 'ChannelType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The channel type.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', - 'description' => 'Result', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to track the cause of the error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"Code\\": \\"NoTenantFound\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n NoTenantFound\\n xxxx\\n EE338D98-9BD3-4413-B165\\n","errorExample":""}]', - ], - 'StartHotlineWork' => [ - 'summary' => '热线坐席上班', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 0\\n}","type":"json"}]', + 'title' => 'Update a skill group', + 'summary' => 'Modifies the skill group information in the Cloud Customer Service System by skill group ID.', + 'changeSet' => [ + ['createdAt' => '2021-03-29T14:35:57.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateTicket' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'title' => '客户请求唯一id，用于幂等校验，可以用uuid生成', - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique client request ID, used for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The AICCS instance ID. You can view this ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'TicketId', 'in' => 'formData', - 'schema' => [ - 'title' => '坐席账号名称(唯一值)，外部账号与XP账号登录名的映射', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ticket ID (ticket code).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '2500000010', 'title' => ''], ], [ - 'name' => 'WorkChannel', + 'name' => 'OperatorId', 'in' => 'formData', - 'schema' => [ - 'title' => '上班渠道，枚举值：(手机上班)PSTN ; (PC上班)PC', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The operator ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '555555', 'title' => ''], ], [ - 'name' => 'SkillGroups', + 'name' => 'FormData', 'in' => 'formData', - 'schema' => [ - 'title' => '坐席热线技能组，格式："[123,456,......,789]"', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ticket modification information, in the format {"key":"value"}.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"questionInfo":"自动化创建工单","CFQyYAPjKb":"开胶"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Result', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, used to trace the cause of errors.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 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.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], - ], - 'FinishHotlineServiceNew' => [ - 'summary' => '热线下班接口，参考FinishHotlineService，坐席通话中下班失败', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'Update a ticket', + 'summary' => 'Updates a ticket by ticket ID.', + 'changeSet' => [ + ['createdAt' => '2021-04-14T08:50:08.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'createTicketWithBizData' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The unique client request ID for idempotence verification. You can use a UUID to generate this ID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS). You can view the instance ID in the Artificial Intelligence Cloud Call Service console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the ticket template.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '30401', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], - ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the business category. If this parameter is not specified, the category of the ticket template is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '397001', 'title' => ''], ], - ], - '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.', - ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the creator (agent ID).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '555555', 'title' => ''], ], - ], - ], - 'GetOnlineTouchSessionList' => [ - 'summary' => '查询在线会话记录信息列表【以touch为维度】', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CreatorType', + 'in' => 'formData', + 'schema' => ['description' => 'The role of the creator. Default value: 4. Valid values:'."\n" + .'- 1: member.'."\n" + .'- 4: customer service representative.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '4', 'title' => ''], ], [ - 'BearerToken' => [], + 'name' => 'CreatorName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the creator.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '刘测试', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'MemberId', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the member. Set this parameter to -1 for anonymous members.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-1', 'example' => '-1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'MemberName', 'in' => 'formData', - 'schema' => [ - 'title' => '实例ID', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The name of the member.', 'type' => 'string', 'required' => false, 'example' => '匿名会员', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'FromInfo', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '技能组id', - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The creation source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'manual', 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'Priority', 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间【会话接通时间筛选范围】，格式：时间戳(毫秒)', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The priority of the ticket. Valid values:'."\n" + .'- 4: normal.'."\n" + .'- 0: low.'."\n" + .'- 1: medium.'."\n" + .'- 2: high.'."\n" + .'- 3: urgent.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '3', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'CarbonCopy', 'in' => 'formData', - 'schema' => [ - 'title' => '结束时间【会话接通时间筛选范围】，格式：时间戳(毫秒)', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The account IDs of the carbon copy recipients. Separate multiple IDs with commas (,).', 'type' => 'string', 'required' => false, 'example' => '234432', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'FormData', 'in' => 'formData', - 'schema' => [ - 'title' => '当前页', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The business fields.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{callout:"1356661xxxx",shoufangren:"晨曦测试公司",authKey:"f866b596d6b2edd409e1243a7xxxxxxx",onecompId:"6666666666"}', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'BizData', 'in' => 'formData', - 'schema' => [ - 'title' => '页数，默认10，最大值30', - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The identification fields required by the business side. If this parameter is not specified for certain businesses, data backflow fails after the ticket is completed. Specify this parameter as needed.', 'type' => 'string', 'required' => false, 'example' => '{callout:"1356661xxxx",shoufangren:"晨曦测试公司",authKey:"f866b596d6b2edd409e1243a7xxxxxxx",onecompId:"6666666666"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PageResult', + 'description' => 'result', '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', - ], + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'The ticket ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2500000010', 'title' => ''], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidInstanceId', 'errorMessage' => 'The specified instance is unavailable or does not exist.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'NoTenantFound', - 'errorMessage' => 'The specified tenant does not exist.', - ], - [ - 'errorCode' => 'SystemError', - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - ], + ['errorCode' => 'SystemError', 'errorMessage' => 'A system error occurred. Please contact the administrator.', 'description' => ''], + ['errorCode' => 'InvalidOperation', 'errorMessage' => 'The operation is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameter', 'errorMessage' => 'The specified parameter is invalid.', 'description' => ''], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2500000010,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a ticket with BIZ fields', + 'summary' => 'Creates a ticket with BIZ fields.', + 'changeSet' => [ + ['createdAt' => '2021-04-07T03:27:41.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], ], 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => 'scsp-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'scsp.aliyuncs.com', 'endpoint' => 'scsp.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'CannotBeNullatSameTime', 'message' => 'Either toolCode or viewCode must be specified.', 'http_code' => 500, 'description' => ''], + ['code' => 'DataIdEndError', 'message' => 'dataIdStart must be a time stamp and cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'DataIdStartError', 'message' => 'dataIdEnd must be a time stamp and cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'DecodeTokenError', 'message' => 'Failed to decode the token.', 'http_code' => 500, 'description' => ''], + ['code' => 'InstanceIdCannotBeNull', 'message' => 'You must specify InstanceId.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidInstanceId', 'message' => 'The specified instance is unavailable or does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidOperation', 'message' => 'The operation is invalid.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter is invalid.', 'http_code' => 500, 'description' => ''], + ['code' => 'InvalidPhone', 'message' => 'phoneNum and havePhoneNum must be either empty or not empty at the same time.', 'http_code' => 400, 'description' => ''], + ['code' => 'NoAgentFound', 'message' => 'The specified agent does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoSkillGroupSetFound', 'message' => 'The specified skill group set does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoTenantFound', 'message' => 'The specified tenant does not exist.', 'http_code' => 500, 'description' => ''], + ['code' => 'NoUserNameFound', 'message' => 'The specified user name does not exist.', 'http_code' => 500, 'description' => '没有找到用户名'], + ['code' => 'SystemError', 'message' => 'A system error occurred. Please contact the administrator.', 'http_code' => 500, 'description' => ''], + ['code' => 'SystemError', 'message' => 'A system error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'TokenExpired', 'message' => 'The token has expired.', 'http_code' => 500, 'description' => 'Token Expired'], + ['code' => 'TokenExpried', 'message' => 'The token has expired.', 'http_code' => 500, 'description' => ''], + ['code' => 'TokenInvalid', 'message' => 'The token is invalid.', 'http_code' => 500, 'description' => ''], + ['code' => 'ViewCodeNotNull', 'message' => 'You must specify ViewCode.', 'http_code' => 500, 'description' => ''], + ], + 'changeSet' => [ [ - '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', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetOnlineTouchSessionList'], + ], + 'createdAt' => '2022-10-20T12:54:38.000Z', + 'description' => '拜耳需求，查询在线会话日志pop接口新增', ], [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'FinishHotlineServiceNew'], + ], + 'createdAt' => '2022-08-02T11:55:03.000Z', + 'description' => '百济三期热线下班接口修改对应hsf', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'StartHotlineWork'], + ], + 'createdAt' => '2022-07-20T12:30:37.000Z', + 'description' => '百济三期热线手机上班需求接口发布', ], [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentDetailWithChannel'], + ], + 'createdAt' => '2022-07-13T11:51:39.000Z', + 'description' => '百济salesforce热线集成接口', ], [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SearchTicketById'], + ], + 'createdAt' => '2022-03-03T09:34:56.000Z', + 'description' => '悉犀客服SearchTicketById支持父工单编号返回', ], [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAllHotLineSkillGroups'], + ], + 'createdAt' => '2022-01-21T08:06:24.000Z', + 'description' => '增加与坐席连线的客户电话信息', ], [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AnwserAgentMonitor'], + ['description' => 'OpenAPI offline', 'api' => 'HangUpAgentMonitor'], + ['description' => 'Response parameters changed', 'api' => 'ListAllHotLineSkillGroups'], + ['description' => 'OpenAPI offline', 'api' => 'StartAgentMonitor'], + ], + 'createdAt' => '2022-01-12T02:43:17.000Z', + 'description' => '热线功能新增坐席监听子功能', ], [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAllHotLineSkillGroups'], + ], + 'createdAt' => '2021-12-21T03:08:38.000Z', + 'description' => '新增坐席展示名称数据返回', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetAllDepartment'], + ['description' => 'OpenAPI offline', 'api' => 'QueryHotlineDashboard'], + ['description' => 'OpenAPI offline', 'api' => 'QueryServicerByDepartmentAndMixName'], + ['description' => 'OpenAPI offline', 'api' => 'QueryServicerById'], + ], + 'createdAt' => '2021-12-16T13:33:43.000Z', + 'description' => '增加部门和坐席API', ], [ - 'regionId' => 'us-west-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListAllHotLineSkillGroups'], + ], + 'createdAt' => '2021-12-15T11:58:46.000Z', + 'description' => '热线转接功能中展示可转接坐席数据', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateSubTicket'], + ['description' => 'OpenAPI offline', 'api' => 'GetByForeignId'], + ['description' => 'OpenAPI offline', 'api' => 'QueryRelationTickets'], + ['description' => 'Request parameters changed', 'api' => 'QueryTickets'], + ], + 'createdAt' => '2021-09-22T15:21:11.000Z', + 'description' => '工单查询接口修改、相关工单查询接口新增、会员信息查询接口新增、创建父子工单接口新增', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateThirdSsoAgent'], + ['description' => 'OpenAPI offline', 'api' => 'GetGrantedRoleIds'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineWaitingNumber'], + ['description' => 'OpenAPI offline', 'api' => 'ListHotlineRecord'], + ['description' => 'OpenAPI offline', 'api' => 'TransferCallToPhone'], + ], + 'createdAt' => '2021-05-18T14:52:49.000Z', + 'description' => '修改响应状态码', ], [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetUserToken'], + ], + 'createdAt' => '2021-05-06T10:52:26.000Z', + 'description' => '新增错误码', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ChangeChatAgentStatus'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOuterCallCenterData'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteAgent'], + ['description' => 'OpenAPI offline', 'api' => 'GenerateWebSocketSign'], + ['description' => 'OpenAPI offline', 'api' => 'GetAgent'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentDetail'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetNumLocation'], + ['description' => 'OpenAPI offline', 'api' => 'GetOuterCallCenterDataList'], + ], + 'createdAt' => '2021-04-27T10:03:45.000Z', + 'description' => '1. 部分接口响应格式增加HttpStatusCode字段2. 增加在线坐席上班和修改坐席状态接口', ], [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CloseTicket'], + ['description' => 'OpenAPI offline', 'api' => 'GetOutbounNumList'], + ['description' => 'OpenAPI offline', 'api' => 'ListOutboundPhoneNumber'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateRingStatus'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateTicket'], + ], + 'createdAt' => '2021-04-14T09:09:44.000Z', + 'description' => '响应结果增加http状态码', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'createTicketWithBizData'], + ], + 'createdAt' => '2021-04-07T03:31:13.000Z', + 'description' => '新增createTicketWithBizData API，增加bizData业务参数代入', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'scsp.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAgent'], + ['description' => 'OpenAPI offline', 'api' => 'CreateRole'], + ['description' => 'OpenAPI offline', 'api' => 'GrantRoles'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateAgent'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateRole'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateSkillGroup'], + ], + 'createdAt' => '2021-03-29T14:37:26.000Z', + 'description' => '1. 历史问题修复', ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'scsp.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartChatWork'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAgentMonitor'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTicketByCaseId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryHotlineDashboard'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryServicerById'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAllHotLineSkillGroups'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeChatAgentStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryServicerByDepartmentAndMixName'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetForeignIdByCMSId'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryRelationTickets'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCallsPerDay'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllDepartment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppMessagePush'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AnwserAgentMonitor'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HangUpAgentMonitor'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSubTicket'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetByForeignId'], ], ], + 'ram' => [ + 'productCode' => 'CCC', + 'productName' => 'Cloud Contact Center', + 'ramCodes' => [], + 'ramLevel' => 'SERVICE', + 'ramActions' => [], + 'resourceTypes' => [], + ], ]; -- cgit v1.2.3