diff options
Diffstat (limited to 'data/en_us/aiccs')
| -rw-r--r-- | data/en_us/aiccs/2019-10-15/api-docs.php | 38174 | ||||
| -rw-r--r-- | data/en_us/aiccs/2023-05-16/api-docs.php | 7018 |
2 files changed, 17372 insertions, 27820 deletions
diff --git a/data/en_us/aiccs/2019-10-15/api-docs.php b/data/en_us/aiccs/2019-10-15/api-docs.php index 7c752e1..9ca6bd9 100644 --- a/data/en_us/aiccs/2019-10-15/api-docs.php +++ b/data/en_us/aiccs/2019-10-15/api-docs.php @@ -1,707 +1,295 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'aiccs', - 'version' => '2019-10-15', - ], + 'info' => ['style' => 'RPC', 'product' => 'aiccs', 'version' => '2019-10-15'], 'directories' => [ [ - 'id' => 208943, - 'title' => null, + 'children' => ['QueryAiVoiceAgentDetailNew', 'PageQueryAgentListNew', 'QueryAiVoiceAgentDetail', 'PageQueryAgentList'], 'type' => 'directory', - 'children' => [ - 'QueryConversationDetailInfoNew', - 'ImportOneTaskPhoneNumber', - 'QueryAiVoiceAgentDetail', - 'PageQueryAgentList', - 'QueryConversationDetailInfo', - 'QueryAiCallDetailPage', - 'StopAiCallTask', - 'CancelAiCallDetails', - 'StartAiCallTask', - 'UpdateAiCallTask', - 'QueryAiCallTaskPage', - 'QueryAiCallTaskDetail', - 'ImportTaskNumberDatas', - 'CreateAiCallTask', - ], + 'title' => 'Communication agent', ], [ - 'id' => 200032, - 'title' => 'Communication Intelligence Engine', + 'children' => ['AddInboundNumber', 'TestLargeModel', 'UpdateLargeModel', 'AddLargeModel', 'AddModelApplication', 'UpdateModelApplication', 'LlmSmartCall', 'LlmSmartCallEncrypt', 'HangupOperate', 'ListAvailableTts', 'GetCallDialogContent'], 'type' => 'directory', - 'children' => [ - 'LlmSmartCall', - 'LlmSmartCallEncrypt', - 'HangupOperate', - 'ListAvailableTts', - 'GetCallDialogContent', - ], + 'title' => 'Communication Intelligence Engine', ], [ - 'id' => 164279, - 'title' => 'Hotline monitoring data', + 'children' => ['ImportOneTaskPhoneNumber', 'QueryConversationDetailInfo', 'QueryAiCallDetailPage', 'StopAiCallTask', 'CancelAiCallDetails', 'StartAiCallTask', 'UpdateAiCallTask', 'QueryAiCallTaskPage', 'QueryAiCallTaskDetail', 'ImportTaskNumberDatas', 'CreateAiCallTask'], 'type' => 'directory', - 'children' => [ - 'GetHotlineServiceStatistics', - 'GetSkillGroupAndAgentStatusSummary', - 'GetDepartmentalLatitudeAgentStatus', - 'GetSkillGroupLatitudeState', - 'GetAgentBasisStatus', - 'GetAgentStatistics', - ], + 'title' => 'Large model call task', ], [ - 'id' => 164286, - 'title' => 'Online monitoring data', + 'children' => ['GetHotlineServiceStatistics', 'GetSkillGroupAndAgentStatusSummary', 'GetDepartmentalLatitudeAgentStatus', 'GetSkillGroupLatitudeState', 'GetAgentBasisStatus', 'GetAgentStatistics'], 'type' => 'directory', - 'children' => [ - 'GetOnlineServiceVolume', - 'GetSeatInformation', - 'GetSkillGroupServiceCapability', - 'GetSkillGroupAgentStatusDetails', - 'GetOnlineSeatInformation', - 'GetQueueInformation', - ], + 'title' => 'Hotline monitoring data', ], [ - 'id' => 164293, - 'title' => 'Hotline Report Data', + 'children' => ['GetOnlineServiceVolume', 'GetSeatInformation', 'GetSkillGroupServiceCapability', 'GetSkillGroupAgentStatusDetails', 'GetOnlineSeatInformation', 'GetQueueInformation'], 'type' => 'directory', - 'children' => [ - 'GetSkillGroupStatusTotal', - 'GetAgentDetailReport', - ], + 'title' => 'Online monitoring data', ], [ - 'id' => 164296, - 'title' => 'online report data', + 'children' => ['GetSkillGroupStatusTotal', 'GetAgentDetailReport'], 'type' => 'directory', - 'children' => [ - 'GetSkillGroupServiceStatus', - 'GetAgentServiceStatus', - ], + 'title' => 'Hotline Report Data', ], [ - 'id' => 164299, - 'title' => 'Seat Management', + 'children' => ['GetSkillGroupServiceStatus', 'GetAgentServiceStatus'], 'type' => 'directory', - 'children' => [ - 'CreateAgent', - 'DeleteAgent', - 'UpdateAgent', - 'GetAgent', - 'ListAgentBySkillGroupId', - 'GetHotlineAgentStatus', - 'RemoveAgentFromSkillGroup', - 'GetHotlineAgentDetail', - ], + 'title' => 'online report data', ], [ - 'id' => 164308, - 'title' => 'Skill Group Management', + 'children' => ['CreateAgent', 'DeleteAgent', 'UpdateAgent', 'GetAgent', 'ListAgentBySkillGroupId', 'GetHotlineAgentStatus', 'RemoveAgentFromSkillGroup', 'GetHotlineAgentDetail'], 'type' => 'directory', - 'children' => [ - 'CreateSkillGroup', - 'UpdateSkillGroup', - 'RemoveSkillGroup', - 'QuerySkillGroups', - 'ListSkillGroup', - 'GetDepGroupTreeData', - ], + 'title' => 'Agent management', ], [ - 'id' => 164315, - 'title' => 'Department Management', + 'children' => ['CreateSkillGroup', 'UpdateSkillGroup', 'RemoveSkillGroup', 'QuerySkillGroups', 'ListSkillGroup', 'GetDepGroupTreeData'], 'type' => 'directory', - 'children' => [ - 'CreateDepartment', - 'GetAllDepartment', - 'DeleteDepartment', - 'UpdateDepartment', - ], + 'title' => 'Skill Group Management', ], [ - 'id' => 164333, - 'title' => 'Channel', + 'children' => ['CreateDepartment', 'GetAllDepartment', 'DeleteDepartment', 'UpdateDepartment'], 'type' => 'directory', - 'children' => [ - 'GenerateWebSocketSign', - ], + 'title' => 'Department Management', ], [ - 'id' => 164335, - 'title' => 'Call Details', + 'children' => ['GenerateWebSocketSign'], 'type' => 'directory', - 'children' => [ - 'HotlineSessionQuery', - 'GetRecordData', - 'GetRecordUrl', - 'DescribeRecordData', - ], + 'title' => 'Channel', ], [ - 'id' => 164340, - 'title' => 'Data statistics', + 'children' => ['HotlineSessionQuery', 'GetRecordData', 'GetRecordUrl', 'DescribeRecordData'], 'type' => 'directory', - 'children' => [ - 'GetIndexCurrentValue', - 'GetAgentIndexRealTime', - 'GetHotlineAgentDetailReport', - 'GetHotlineGroupDetailReport', - ], + 'title' => 'Call Details', ], [ - 'id' => 164345, - 'title' => 'Session Data', + 'children' => ['GetIndexCurrentValue', 'GetAgentIndexRealTime', 'GetHotlineAgentDetailReport', 'GetHotlineGroupDetailReport'], 'type' => 'directory', - 'children' => [ - 'QueryTouchList', - 'GetCustomerInfo', - 'GetHotlineMessageLog', - 'GetHotlineCallAction', - ], + 'title' => 'Data statistics', ], [ - 'id' => 164350, - 'title' => 'Robot outbound call', + 'children' => ['QueryTouchList', 'GetCustomerInfo', 'GetHotlineMessageLog', 'GetHotlineCallAction'], 'type' => 'directory', - 'children' => [ - 'RobotCall', - 'ListRobotCallDialog', - 'ListAiccsRobot', - 'ListRobotParams', - 'GetCallSoundRecord', - 'ListRobotNode', - ], + 'title' => 'Session data', ], [ - 'id' => 164357, - 'title' => 'Robot outbound task', + 'children' => ['RobotCall', 'ListRobotCallDialog', 'ListAiccsRobot', 'ListRobotParams', 'GetCallSoundRecord', 'ListRobotNode'], 'type' => 'directory', - 'children' => [ - 'CreateTask', - 'AttachTask', - 'StartTask', - 'StopTask', - 'CancelTask', - 'ListTask', - 'ListTaskDetail', - 'ListDialog', - ], + 'title' => 'Automated outbound calls', ], [ - 'id' => 164366, - 'title' => 'Intelligent voice interaction', + 'children' => ['CreateTask', 'AttachTask', 'StartTask', 'StopTask', 'CancelTask', 'ListTask', 'ListTaskDetail', 'ListDialog'], 'type' => 'directory', - 'children' => [ - 'SendCcoSmartCall', - 'SendCcoSmartCallOperate', - ], + 'title' => 'Automated outbound calling', ], [ - 'id' => 164370, - 'title' => 'Intelligent Outcall Tasks', + 'children' => ['CreateAiOutboundTask', 'CreateAiOutboundTaskBatch', 'DeleteAiOutboundTask', 'GetAiOutboundTaskBizData', 'GetAiOutboundTaskExecDetail', 'GetAiOutboundTaskDetail', 'UpdateAiOutboundTask', 'InsertAiOutboundPhoneNums', 'GetAiOutboundTaskProgress', 'StopAiOutboundTask', 'TerminateAiOutboundTask', 'GetAiOutboundTaskList', 'StartAiOutboundTask'], 'type' => 'directory', - 'children' => [ - 'CreateAiOutboundTask', - 'CreateAiOutboundTaskBatch', - 'DeleteAiOutboundTask', - 'GetAiOutboundTaskBizData', - 'GetAiOutboundTaskExecDetail', - 'GetAiOutboundTaskDetail', - 'UpdateAiOutboundTask', - 'InsertAiOutboundPhoneNums', - 'GetAiOutboundTaskProgress', - 'StopAiOutboundTask', - 'TerminateAiOutboundTask', - 'GetAiOutboundTaskList', - 'StartAiOutboundTask', - ], + 'title' => 'Intelligent outbound call tasks', ], [ - 'id' => 164384, - 'title' => 'Number Management', + 'children' => ['AddHotlineNumber', 'DeleteHotlineNumber', 'ResetHotlineNumber', 'QueryHotlineNumber', 'GetConfigNumList'], 'type' => 'directory', - 'children' => [ - 'AddHotlineNumber', - 'DeleteHotlineNumber', - 'ResetHotlineNumber', - 'QueryHotlineNumber', - 'GetConfigNumList', - ], + 'title' => 'Number Management', ], [ - 'id' => 164813, - 'title' => 'Traffic Management', + 'children' => ['AnswerCall', 'FinishHotlineService', 'GetNumLocation', 'GetRtcToken', 'HangupCall', 'ListHotlineRecord', 'ListOutboundPhoneNumber', 'MakeDoubleCall', 'SendHotlineHeartBeat', 'StartCall', 'StartHotlineService', 'SuspendHotlineService'], 'type' => 'directory', - 'children' => [ - 'AnswerCall', - 'FinishHotlineService', - 'GetNumLocation', - 'GetRtcToken', - 'HangupCall', - 'ListHotlineRecord', - 'ListOutboundPhoneNumber', - 'MakeDoubleCall', - 'SendHotlineHeartBeat', - 'StartCall', - 'StartHotlineService', - 'SuspendHotlineService', - ], + 'title' => 'Call management', ], [ - 'id' => 165936, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'AddOuterAccount', - 'AiccsSmartCall', - 'AiccsSmartCallOperate', - 'BatchCreateQualityProjects', - 'ChangeChatAgentStatus', - 'ChangeQualityProjectStatus', - 'CreateOutboundTask', - 'CreateQualityProject', - 'CreateQualityRule', - 'CreateThirdSsoAgent', - 'DeleteOutboundTask', - 'DeleteOuterAccount', - 'DeleteQualityProject', - 'DeleteQualityRule', - 'EditQualityProject', - 'EditQualityRule', - 'EditQualityRuleTag', - 'EncryptPhoneNum', - 'FetchCall', - 'GetAgentById', - 'GetHotlineRuntimeInfo', - 'GetHotlineWaitingNumber', - 'GetInstanceList', - 'GetMcuLvsIp', - 'GetOutbounNumList', - 'GetQualityProjectDetail', - 'GetQualityProjectList', - 'GetQualityProjectLog', - 'GetQualityResult', - 'GetQualityRuleDetail', - 'GetQualityRuleList', - 'GetQualityRuleTagList', - 'HangUpDoubleCall', - 'HangupThirdCall', - 'HoldCall', - 'InsertTaskDetail', - 'JoinThirdCall', - 'ListChatRecordDetail', - 'ListHotlineRecordDetail', - 'ListRoles', - 'MakeCall', - 'QueryHotlineInQueue', - 'QueryOutboundTask', - 'QueryTaskDetail', - 'QueryTickets', - 'RestartOutboundTask', - 'StartCallV2', - 'StartChatWork', - 'StartMicroOutbound', - 'SuspendOutboundTask', + 'AddOuterAccount', 'AddSkillGroup', 'AiccsSmartCall', 'AiccsSmartCallOperate', 'BatchCreateQualityProjects', 'ChangeChatAgentStatus', 'ChangeQualityProjectStatus', 'CreateOutboundTask', 'CreateQualityProject', 'CreateQualityRule', 'CreateThirdSsoAgent', 'DeleteOutboundTask', 'DeleteOuterAccount', 'DeleteQualityProject', 'DeleteQualityRule', 'DeleteSkillGroup', 'EditQualityProject', 'EditQualityRule', 'EditQualityRuleTag', 'EncryptPhoneNum', + 'FetchCall', 'GetAgentById', 'GetAudioNoteUploadUrl', 'GetHotlineRuntimeInfo', 'GetHotlineWaitingNumber', 'GetInstanceList', 'GetMcuLvsIp', 'GetOutbounNumList', 'GetQualityProjectDetail', 'GetQualityProjectList', 'GetQualityProjectLog', 'GetQualityResult', 'GetQualityRuleDetail', 'GetQualityRuleList', 'GetQualityRuleTagList', 'HangUpDoubleCall', 'HangupThirdCall', 'HoldCall', 'InsertTaskDetail', 'JoinThirdCall', + 'ListChatRecordDetail', 'ListHotlineRecordDetail', 'ListRoles', 'LlmFullDuplexCallOperate', 'LlmSmartCallFullDuplex', 'MakeCall', 'QueryConversationDetailInfoNew', 'QueryHotlineInQueue', 'QueryOutboundTask', 'QueryTaskDetail', 'QueryTickets', 'RestartOutboundTask', 'SendCcoSmartCall', 'SendCcoSmartCallOperate', 'StartCallV2', 'StartChatWork', 'StartMicroOutbound', 'SubmitAudioNote', 'SuspendOutboundTask', 'TransferCallToSkillGroup', 'UpdateOuterAccount', - 'TransferCallToSkillGroup', - 'AddSkillGroup', - 'DeleteSkillGroup', ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ 'schemas' => [], ], 'apis' => [ - 'QueryConversationDetailInfoNew' => [ - 'summary' => '查询通话记录接口-新', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddHotlineNumber' => [ + 'summary' => 'Invoke the AddHotlineNumber API to add a hotline number.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '138************', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it in the Intelligent Contact Center console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'DetailId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '9662*************', - ], + 'name' => 'HotlineNumber', + 'in' => 'formData', + 'schema' => ['description' => 'Hotline number.', 'example' => '05710000****', 'pattern' => '^\\d+$', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CallId', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Description of the number.', 'example' => '热线号码', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'EnableInbound', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether the number is used for inbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'InboundFlowId', + 'in' => 'formData', + 'schema' => ['description' => 'The IVR flow ID for inbound calls. You can obtain it on the SaaS Workbench > Channel Integration > IVR Flow Management page.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'EnableOutbound', + 'in' => 'formData', + 'schema' => ['description' => 'Whether it is used for outbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'OutboundAllDepart', + 'in' => 'formData', + 'schema' => ['description' => 'Whether outbound calls apply to all departments under the instance.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EnableInboundEvaluation', + 'in' => 'formData', + 'schema' => ['description' => 'Whether inbound satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EnableOutboundEvaluation', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether outbound call satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EvaluationLevel', + 'in' => 'formData', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Satisfaction Level. Valid values: '."\n" + ."\n" + .'- **2**: Two-level (Satisfied, Not satisfied) '."\n" + .'- **3**: Three-level (Satisfied, Neutral, Not satisfied) '."\n" + .'- **4**: Four-level (Very satisfied, Satisfied, Neutral, Not satisfied) '."\n" + .'- **5**: Five-level (Very satisfied, Satisfied, Neutral, Not satisfied, Very poor)', + 'example' => '2', + 'format' => 'int32', 'required' => false, - 'example' => '1552********^1420********', + 'title' => '', + 'type' => 'integer', + 'enum' => ['2', '3', '4', '5'], ], ], [ - 'name' => 'OutId', - 'in' => 'query', + 'name' => 'OutboundRangeList', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Outbound call effective scope.', + 'items' => [ + 'description' => 'Outbound call effective scope.', + 'properties' => [ + 'GroupIdList' => [ + 'description' => 'List of effective skill groups. '."\n" + .'> If the skill group list is empty, the setting applies to the entire department. Otherwise, it applies only to the specified skill groups under the department.', + 'items' => ['description' => 'Skill group ID.', 'example' => '1234', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'DepartmentId' => ['description' => 'Effective department ID.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + 'required' => false, + 'type' => 'object', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '123******', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CallerPhone' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0571*******', - ], - 'Options' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ANSWERED', - ], - 'StatusMsg' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'ConversationTurnCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '138************', - ], - 'StartCallTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1286987391', - ], - 'StatusCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200005', - ], - 'CalledPhone' => [ - 'description' => '', - 'type' => 'string', - 'example' => '130********', - ], - 'Variables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Required' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'mike', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'name', - ], - 'Source' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'source', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'user name', - ], - ], - ], - 'example' => '', - ], - 'RecordingFileDownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'recording.oss.file', - ], - 'PickUpTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12349732441', - ], - 'ConversationRecord' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - 'ImportedTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], - 'EncryptionType' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'MajorIntent' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A', - ], - 'CallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123*******^213******', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234******', - ], - 'FailedReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Duration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'HangupDirection' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'DetailId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1234*******', - ], - 'ReleaseTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'OutId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123***', - ], - 'OutputTags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OutputTagDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'OutputTagName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'OutputTagValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'title' => '', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'The status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束（双呼）\\",\\n \\"ConversationTurnCount\\": 23,\\n \\"TaskId\\": \\"138************\\",\\n \\"StartCallTime\\": 1286987391,\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"130********\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"mike\\",\\n \\"Id\\": \\"123\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"source\\",\\n \\"Name\\": \\"user name\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"recording.oss.file\\",\\n \\"PickUpTime\\": 12349732441,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n }]\\",\\n \\"Status\\": 72,\\n \\"ImportedTime\\": 43,\\n \\"EncryptionType\\": 28,\\n \\"MajorIntent\\": \\"A\\",\\n \\"CallId\\": \\"123*******^213******\\",\\n \\"BatchId\\": \\"1234******\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 30,\\n \\"HangupDirection\\": \\"0\\",\\n \\"DetailId\\": \\"1234*******\\",\\n \\"ReleaseTime\\": 7,\\n \\"OutId\\": \\"123***\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高（非常积极，大概率转化）\\\\\\"]\\",\\n \\"Id\\": \\"12\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'ImportOneTaskPhoneNumber' => [ - 'summary' => '语音智能体外呼任务导入单条数据', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add Hotline Number', + 'description' => '> Hotline numbers are for inbound and outbound calls only.', + 'changeSet' => [ + ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddHotlineNumber'], + ], ], + ], + 'AddInboundNumber' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'LineCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1231231212****', - ], + 'schema' => ['description' => 'The code for the custom line.', 'type' => 'string', 'required' => false, 'example' => 'JILIANG_*****_TEST_NET', 'title' => ''], ], [ - 'name' => 'OutId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '94ba739b-c01a-ef91-335d-4be006c34899', - ], - ], - [ - 'name' => 'PhoneNumber', + 'name' => 'InboundNumbers', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The inbound number.', 'type' => 'string', 'required' => false, 'example' => '24243248*****33', 'title' => ''], 'required' => true, - 'example' => '180******', + 'description' => 'A list of inbound numbers.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EncryptionType', + 'name' => 'InboundType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '81', - ], + 'schema' => ['description' => 'The line type. Valid values: `1` (cloud communication resource) and `2` (customer-owned line).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '8', 'title' => ''], ], [ - 'name' => 'Variables', + 'name' => 'ApplicationCode', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The code of the large model application.', 'type' => 'string', 'required' => true, 'example' => 'DLWERWLD', 'title' => ''], ], ], 'responses' => [ @@ -709,85 +297,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', - ], + 'AccessDeniedDetail' => ['description' => 'Details about why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', 'title' => ''], + 'Message' => ['description' => 'The status code description.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DetailId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '92304322323*****', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'The error description.', 'type' => 'string', 'example' => '号码不合法', 'title' => ''], + 'InboundNumber' => ['description' => 'The inbound number.', 'type' => 'string', 'example' => '234234238**33', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the number was added successfully. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'example' => '', + 'description' => 'The returned data.', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddInboundNumber', + 'summary' => 'Adds one or more inbound numbers.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Data\\": {\\n \\"DetailId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Message\\": \\"号码不合法\\",\\n \\"InboundNumber\\": \\"234234238**33\\",\\n \\"Result\\": false\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'QueryAiVoiceAgentDetail' => [ - 'summary' => '查询智能体明细', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddLargeModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'none', + 'abilityTreeCode' => '255142', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], ], 'parameters' => [ [ - 'name' => 'AgentId', + 'name' => 'ModelName', + 'in' => 'query', + 'schema' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name', 'title' => ''], + ], + [ + 'name' => 'ModelUrl', + 'in' => 'query', + 'schema' => ['description' => 'The model URL.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'AuthCode', 'in' => 'query', + 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxxxxxxxxx*******xx', 'title' => ''], + ], + [ + 'name' => 'Temperature', + 'in' => 'query', + 'schema' => ['description' => 'The temperature.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], + ], + [ + 'name' => 'TopP', + 'in' => 'query', + 'schema' => ['description' => 'The `top-p` value.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], + ], + [ + 'name' => 'TopK', + 'in' => 'query', + 'schema' => ['description' => 'The `top-k` value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'BaseModel', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The base model.', + 'type' => 'array', + 'items' => ['description' => 'The base model name.', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', 'title' => ''], 'required' => false, - 'example' => '123123********', + 'example' => '', + 'title' => '', ], ], ], @@ -796,823 +405,214 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - '', - '', - '', - '', - ], - 'example' => '7', - ], - 'BusinessTypeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'AiVoiceAgentModelConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BasicTaskDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'MainPurpose' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MainPurposeEnum' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd5606d80-7625-dcea-8610-17f66fbb564a', - ], - ], - ], - 'example' => '', - ], - 'MainPurposeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'MainPurposeType' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ENUM', - ], - 'MainPurposeDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1ee6e994-08e0-5e87-f662-1659cc54d409', - ], - ], - 'example' => '', - ], - 'ChildTaskList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ChildTaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'ChildTaskDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '280cd4bf-*******df472c', - ], - ], - ], - 'example' => '', - ], - 'CustomExceptionFileName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'StartWordType' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BusinessType' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - '', - '', - ], - 'example' => '1', - ], - 'CustomExceptionUrlPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-', - ], - 'KnowledgeId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1232131*******', - ], - 'KnowledgeDocOriginalNameList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'example' => '', - ], - 'KnowledgeEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CustomExceptionEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Prologue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CustomExceptionFileId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'PhoneTagConfig' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'PhoneTagType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ENUM' => '', - 'TEXT' => '', - ], - 'example' => 'ENUM', - ], - 'PhoneTagName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'PhoneTagRequired' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '280cd4bf-*******df472c'."\n", - ], - 'PhoneTagSource' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'PhoneTagDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'PhoneTagEnum' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'c3d4ff4e-*********bc26dc044682', - ], - ], - ], - 'example' => '', - ], - 'PhoneTagKey' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'testParam', - ], - ], - ], - 'example' => '', - ], - 'FlowDesc' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'UserRole' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TaskType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'BASIC' => '', - 'ADVANCED' => '', - ], - 'example' => 'ADVANCED', - ], - 'SysRole' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'OutputTagConfig' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OutputTagDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'OutputTagType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ENUM' => '', - 'TEXT' => '', - ], - 'example' => 'ENUM', - ], - 'OutputTagEnum' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8757************2c499fa', - ], - ], - ], - 'example' => '', - ], - 'OutputTagName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8757************2c499fa'."\n", - ], - ], - ], - 'example' => '', - ], - 'CustomExceptionVoiceStyle' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - ], - 'example' => '2', - ], - 'RecordingFile' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CustomExceptionList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ExceptionType' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-', - ], - 'SupportBreak' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Reply' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-', - ], - 'ExceptionSign' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - 'example' => '', - ], - 'KnowledgeDocNameList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '117d2********388f2a615be5c0d3546e.xlsx', - ], - 'example' => '', - ], - 'KnowledgeDocIdList' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12213******', - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'KnowledgeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'VoiceStyleName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AgentId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12311212******', - ], - 'AgentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'AiVoiceAgentCallConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VocabId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'afb2c43**********83e6df30551c11f7', - ], - 'TtsConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'VoiceCode' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'MixingTemplate' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BackgroundEnabled' => [ - 'type' => 'boolean', - 'example' => 'true', - ], - 'TtsVolume' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - 'TtsStyle' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'longxiaoxia_v2p1', - ], - 'VoiceType' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'MixingEnabled' => [ - 'type' => 'boolean', - 'example' => 'true', - ], - 'TtsSpeed' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'BackgroundSound' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BackgroundVolume' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'EventConfig' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'MuteActive' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'SessionTimeout' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600', - ], - 'CallAssistantHangup' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'CallAssistantRecognize' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'MuteDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'MuteHangupNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'AccessDeniedDetail' => ['description' => 'The reason for the authentication failure.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'B1B8E483-372F-5AA8-A4B2-CA82EC967B0C'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Code' => ['description' => 'The status code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'AddLargeModel', + 'summary' => 'Adds a large language model.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"Status\\": 7,\\n \\"BusinessTypeName\\": \\"个人线索转化\\",\\n \\"Description\\": \\"日常测试使用。\\",\\n \\"AiVoiceAgentModelConfig\\": {\\n \\"BasicTaskDescription\\": \\"任务描述。\\",\\n \\"MainPurpose\\": {\\n \\"MainPurposeEnum\\": [\\n {\\n \\"Description\\": \\"意向强烈。\\",\\n \\"Value\\": \\"A\\",\\n \\"Id\\": \\"d5606d80-7625-dcea-xxxx-17f66fbb564a\\"\\n }\\n ],\\n \\"MainPurposeName\\": \\"通话效果评级\\",\\n \\"MainPurposeType\\": \\"ENUM\\",\\n \\"MainPurposeDescription\\": \\"通话效果评级：A、B、C、D，（A最好）\\",\\n \\"Id\\": \\"1ee6e994-08e0-xxxx-f662-1659cc54d409\\"\\n },\\n \\"ChildTaskList\\": [\\n {\\n \\"ChildTaskName\\": \\"开场与邀约\\",\\n \\"ChildTaskDescription\\": \\"新用户邀约: \\\\\\\\\\\\\\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\\\\\\\\\",\\n \\"Id\\": \\"280cd4bf-*******df472c\\"\\n }\\n ],\\n \\"CustomExceptionFileName\\": \\"异常测试文件.xlsx\\",\\n \\"StartWordType\\": 1,\\n \\"BusinessType\\": 1,\\n \\"CustomExceptionUrlPath\\": \\"-\\",\\n \\"KnowledgeId\\": \\"1232131*******\\",\\n \\"KnowledgeDocOriginalNameList\\": [\\n \\"**会话引擎测试.xlsx\\"\\n ],\\n \\"KnowledgeEnable\\": false,\\n \\"CustomExceptionEnable\\": false,\\n \\"Prologue\\": \\"你好，这里是******。\\",\\n \\"CustomExceptionFileId\\": \\"OSS文件ID\\",\\n \\"PhoneTagConfig\\": [\\n {\\n \\"PhoneTagType\\": \\"ENUM\\",\\n \\"PhoneTagName\\": \\"意向车系\\",\\n \\"PhoneTagRequired\\": true,\\n \\"Id\\": \\"280cd4bf-*******df472c\\\\n\\",\\n \\"PhoneTagSource\\": \\"示例值\\",\\n \\"PhoneTagDescription\\": \\"用户感兴趣的车系。\\",\\n \\"PhoneTagEnum\\": [\\n {\\n \\"Description\\": \\"客户完全不接受挽留\\",\\n \\"Value\\": \\"完全不接受\\",\\n \\"Id\\": \\"c3d4ff4e-*********bc26dc044682\\"\\n }\\n ],\\n \\"PhoneTagKey\\": \\"testParam\\"\\n }\\n ],\\n \\"FlowDesc\\": \\"这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍\\",\\n \\"UserRole\\": \\"急需课程的新用户\\",\\n \\"TaskType\\": \\"ADVANCED\\",\\n \\"SysRole\\": \\"课程销售\\",\\n \\"OutputTagConfig\\": [\\n {\\n \\"OutputTagDescription\\": \\"记录本次通话的最终状态\\",\\n \\"OutputTagType\\": \\"ENUM\\",\\n \\"OutputTagEnum\\": [\\n {\\n \\"Description\\": \\"高（非常积极，大概率转化）\\",\\n \\"Value\\": \\"高\\",\\n \\"Id\\": \\"8757************2c499fa\\"\\n }\\n ],\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"Id\\": \\"8757************2c499fa\\\\n\\"\\n }\\n ],\\n \\"CustomExceptionVoiceStyle\\": 2,\\n \\"RecordingFile\\": \\"示例值\\",\\n \\"CustomExceptionList\\": [\\n {\\n \\"ExceptionType\\": \\"-\\",\\n \\"SupportBreak\\": false,\\n \\"Reply\\": \\"-\\",\\n \\"ExceptionSign\\": true\\n }\\n ],\\n \\"KnowledgeDocNameList\\": [\\n \\"117d2********388f2a615be5c0d3546e.xlsx\\"\\n ],\\n \\"KnowledgeDocIdList\\": [\\n \\"12213******\\"\\n ]\\n },\\n \\"KnowledgeName\\": \\"测试知识库\\",\\n \\"VoiceStyleName\\": \\"亲切\\",\\n \\"AgentId\\": 0,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AiVoiceAgentCallConfig\\": {\\n \\"VocabId\\": \\"afb2c43**********83e6df30551c11f7\\",\\n \\"TtsConfig\\": {\\n \\"VoiceCode\\": \\"示例值\\",\\n \\"MixingTemplate\\": 1,\\n \\"BackgroundEnabled\\": true,\\n \\"TtsVolume\\": 72,\\n \\"TtsStyle\\": \\"longxiaoxia_v2p1\\",\\n \\"VoiceType\\": \\"示例值\\",\\n \\"MixingEnabled\\": true,\\n \\"TtsSpeed\\": 34,\\n \\"BackgroundSound\\": 1,\\n \\"BackgroundVolume\\": 1\\n },\\n \\"EventConfig\\": {\\n \\"MuteActive\\": false,\\n \\"SessionTimeout\\": 600,\\n \\"CallAssistantHangup\\": false,\\n \\"CallAssistantRecognize\\": true,\\n \\"MuteDuration\\": 10,\\n \\"MuteHangupNum\\": 1\\n }\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"B1B8E483-372F-5AA8-A4B2-CA82EC967B0C\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'PageQueryAgentList' => [ - 'summary' => '分页查询智能体列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddModelApplication' => [ + 'summary' => 'Add a model application', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '254052', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'AgentId', + 'name' => 'ApplicationName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1231*******', - ], + 'schema' => ['description' => 'The name of the model application.', 'type' => 'string', 'required' => true, 'example' => '测试应用', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApplicationCps', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of concurrent requests per second (CPS).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '25', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'ModelCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The model code.', 'type' => 'string', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'AgentName', + 'name' => 'ModelVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The model version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => ['description' => 'The qualification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85', 'title' => ''], + ], + [ + 'name' => 'QualificationName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the qualification.', 'type' => 'string', 'required' => false, 'example' => '测试资质', 'title' => ''], + ], + [ + 'name' => 'SpeechId', + 'in' => 'query', + 'schema' => ['description' => 'The speech script ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88', 'title' => ''], + ], + [ + 'name' => 'SpeechContent', + 'in' => 'query', + 'schema' => ['description' => 'The speech script content.', 'type' => 'string', 'required' => false, 'example' => '测试话术。', 'title' => ''], + ], + [ + 'name' => 'UsageDesc', + 'in' => 'query', + 'schema' => ['description' => 'The purpose of the application.', 'type' => 'string', 'required' => false, 'example' => '测试用途', 'title' => ''], + ], + [ + 'name' => 'DyvmsSceneName', + 'in' => 'query', + 'schema' => ['description' => 'The scene name.', 'type' => 'string', 'required' => false, 'example' => '测试场景', 'title' => ''], + ], + [ + 'name' => 'StartWord', + 'in' => 'query', + 'schema' => ['description' => 'The opening line.', 'type' => 'string', 'required' => true, 'example' => '你好，这是一句开场白。', 'title' => ''], + ], + [ + 'name' => 'StartWordType', 'in' => 'query', + 'schema' => ['description' => 'The type of the opening line.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：文本'."\n" + .'1：录音', 'title' => ''], + ], + [ + 'name' => 'RecordingFile', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the audio file for the opening line. This parameter is required if `StartWordType` is set to `1`.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxx.wav', 'title' => ''], + ], + [ + 'name' => 'Prompt', + 'in' => 'query', + 'schema' => ['description' => 'The prompt.', 'type' => 'string', 'required' => false, 'example' => '测试提示词。', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source. The value must be `USER`.', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], + ], + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - '', - '', - '', - '', + 'description' => 'The TTS configuration, including voice, volume, speech speed, and more.', + 'type' => 'object', + 'properties' => [ + 'VoiceCode' => ['description' => 'The voice code.', 'type' => 'string', 'required' => false, 'example' => 'ddddfd', 'title' => ''], + 'MixingTemplate' => ['description' => 'The mixing template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'BackgroundEnabled' => ['description' => 'Specifies whether to enable background sound.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TtsVolume' => ['description' => 'The volume for TTS playback. Valid values: 0–100. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '55', 'title' => ''], + 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'required' => false, 'example' => '龙小夏', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => 'example', 'title' => ''], + 'CustomerAccountId' => ['description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '45', 'title' => ''], + 'VoiceType' => ['description' => 'The voice type.'."\n" + ."\n" + .'```'."\n" + .'SYSTEM: System voice'."\n" + .'COSYCLONE: Cloned voice'."\n" + .'BL-CUSTOM: Premium custom cloned voice'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], + 'MixingEnabled' => ['description' => 'Specifies whether to enable mixing.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TtsSpeed' => ['description' => 'The speech speed for TTS playback. Valid values: -200–200. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '13', 'title' => ''], + 'BackgroundSound' => ['description' => 'The background sound ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'BackgroundVolume' => ['description' => 'The background sound volume.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：low'."\n" + .'1：medium'."\n" + .'2：high', 'title' => ''], ], - 'example' => '7', + 'required' => true, + 'example' => '', + 'title' => '', ], ], + [ + 'name' => 'MuteDuration', + 'in' => 'query', + 'schema' => ['description' => 'The mute duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70', 'title' => ''], + ], + [ + 'name' => 'MuteActive', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the first mute event triggers the model.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'MuteHangupNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of consecutive mute events that trigger an automatic hang-up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'CallConnectedTriggerModel', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to push an event notification when a call is connected. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - 1 => '', - '', - '', - '', - '', - '', - '', - '', - ], - 'example' => '7', - ], - 'LastOnlineTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-10-28 14:38:15', - ], - 'ModifyTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-10-28 17:10:17', - ], - 'Description' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2025-10-28 17:10:17', - ], - 'AuditReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'BuildFailReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '构建失败原因', - ], - 'ApplicationCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'DFAS*****', - ], - 'BusinessTypeName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'WithConfig' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AgentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'AgentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '121312*******', - ], - 'WithActivePrompt' => [ - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'example' => '', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denied error.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798'], + 'Message' => ['description' => 'The message that explains the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Data' => ['description' => 'The returned application code.', 'type' => 'string', 'title' => '', 'example' => '325****2D2'], + 'Code' => ['description' => 'The status code. A value of OK indicates a successful request.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AddModelApplication', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 14,\\n \\"List\\": [\\n {\\n \\"Status\\": 7,\\n \\"LastOnlineTime\\": \\"2025-10-28 14:38:15\\",\\n \\"ModifyTime\\": \\"2025-10-28 17:10:17\\",\\n \\"Description\\": \\"用于日常测试\\",\\n \\"CreateTime\\": \\"2025-10-28 17:10:17\\",\\n \\"AuditReason\\": \\"请补充流程说明\\",\\n \\"BuildFailReason\\": \\"系统错误\\",\\n \\"ApplicationCode\\": \\"DFAS*****\\",\\n \\"BusinessTypeName\\": \\"个人客户线索转化\\",\\n \\"WithConfig\\": false,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"121312*******\\",\\n \\"WithActivePrompt\\": false\\n }\\n ],\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"325****2D2\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'QueryConversationDetailInfo' => [ - 'summary' => '查询通话详情信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AddOuterAccount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1620,1198 +620,830 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'OuterAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1231321231****', - ], + 'schema' => ['description' => 'External Account ID.', 'docRequired' => true, 'example' => '1212', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DetailId', + 'name' => 'OuterAccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1231321231****'."\n", - ], + 'schema' => ['description' => 'External account type.', 'docRequired' => true, 'example' => 'alipay', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'BatchId', + 'name' => 'OuterAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1231321231****'."\n", - ], + 'schema' => ['description' => 'External account name.', 'example' => '测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Avatar', + 'in' => 'query', + 'schema' => ['description' => 'Profile picture.', 'example' => 'http://****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'RealName', + 'in' => 'query', + 'schema' => ['description' => 'Real name of the account.', 'example' => '张三', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterDepartmentId', + 'in' => 'query', + 'schema' => ['description' => 'External department ID.', 'example' => '3', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'List of external skill group IDs. Separate multiple IDs with commas (,).', 'example' => '["222","333","444"]', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Ext', + 'in' => 'query', + 'schema' => ['description' => 'Extension field, in JSON string format.', 'example' => '{"备注":"临时技能组"}', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterDepartmentType', + 'in' => 'query', + 'schema' => ['description' => 'External department type: Invalid department type.', 'example' => 'type_invalid', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterGroupType', + 'in' => 'query', + 'schema' => ['description' => 'Skill group type.', 'example' => 'mybank', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CallerPhone' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'EncryptionType' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CallResult' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'StatusMsg' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'StartCallTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'MajorIntent' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallId' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'FailedReason' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Duration' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16', - ], - 'HangupDirection' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'StatusCode' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CalledPhone' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Variables' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Required' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Value' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'name', - ], - 'Source' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - ], - ], - 'example' => '', - ], - 'RecordingFileDownloadUrl' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://********', - ], - 'ReleaseTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'PickUpTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1212131231231', - ], - 'OutId' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'ConversationRecord' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'OutputTags' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'OutputTagDescription' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'OutputTagName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'OutputTagValue' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'd7f3e92b-7947-4c20-bf37-ef66fc71007b', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Created Account ID.', 'example' => '123456', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F2051E18-FF3F-5C08-8D24-6F150D2AF757\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"EncryptionType\\": \\"示例值\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束（双呼）\\",\\n \\"StartCallTime\\": 123123123123123,\\n \\"MajorIntent\\": \\"D\\",\\n \\"CallId\\": \\"1231231231213^11231231231\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 16,\\n \\"HangupDirection\\": \\"用户\\",\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"186******\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"张三\\",\\n \\"Id\\": \\"22\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"示例值\\",\\n \\"Name\\": \\"姓名\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"https://********\\",\\n \\"ReleaseTime\\": 98,\\n \\"PickUpTime\\": 1754617273000,\\n \\"OutId\\": \\"bb3bc32d-54b8-49c4-80d3-61583417d22e\\\\n\\",\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎，我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好，\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，那我是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了，111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快！再见！\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n }\\\\n]\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高（非常积极，大概率转化）\\\\\\"]\\",\\n \\"Id\\": \\"9ca2*****************************\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryAiCallDetailPage' => [ - 'summary' => '查询明细记录', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add External Associated Account', + 'summary' => 'Invoke AddOuterAccount to add an external account.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'AddSkillGroup' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '269272', - 'abilityTreeNodes' => [ - 'FEATUREaiccsTY5M4L', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'OuterGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1212131231****', - ], + 'schema' => ['description' => 'ID of the external skill group.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'OuterGroupName', + 'in' => 'query', + 'schema' => ['description' => 'Name of the external skill group.', 'docRequired' => true, 'example' => '热线技能组', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterGroupType', + 'in' => 'query', + 'schema' => ['description' => 'Type of the external skill group.', 'docRequired' => true, 'example' => 'mybank', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterDepartmentId', 'in' => 'query', + 'schema' => ['description' => 'ID of the external department.', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterDepartmentType', + 'in' => 'query', + 'schema' => ['description' => 'Type of the external department.', 'example' => 'type_invalid', 'required' => false, 'type' => 'string', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'enumValueTitles' => [ - '', - '', - '', + 'description' => 'Schema of Response', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'ID of the created skill group.', 'example' => '123456', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'example' => '0', + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a Skill Group', + 'summary' => 'Invoke AddSkillGroup to create an external skill group.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'AiccsSmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'BatchId', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1212131231****'."\n", - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], + ], + [ + 'name' => 'CalledShowNumber', + 'in' => 'query', + 'schema' => ['description' => 'The caller ID displayed to the callee. This must be a number you have purchased.'."\n" + ."\n" + .'You can log on to the [Contact Center console](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte) to view your purchased numbers.', 'example' => '0571000****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '053714454****', - ], + 'schema' => ['description' => 'Called number. Only numbers in the Chinese mainland are supported. ', 'example' => '1862222****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EncryptionType', + 'name' => 'VoiceCode', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '73', - ], + 'schema' => ['description' => 'The Intelligent Outbound Call playback audio file supports both network files and TTS. Multiple files and TTS parameters can be mixed for playback, separated by commas (,). The replacement values for TTS parameters are specified in **VoiceCodeParam**.'."\n" + ."\n" + .'- When the playback file is a network file: Set the VoiceCode parameter to a publicly accessible URL of the audio file. We recommend using a WAV-formatted audio file with a sampling frequency of 8000 Hz or 16000 Hz.'."\n" + .'- When the playback file uses TTS: Set the VoiceCode parameter to a variable name such as $name$, and define the corresponding content for this variable in VoiceCodeParam.', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CallResult', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CALL_FORWARDING' => '', - 'INCOMING_CALL_BARRED' => '', - 'CALL_REJECTED' => '', - 'ANSWERED' => '', - 'USER_BUSY' => '', - 'POWERED_OFF' => '', - 'NO_USER_RESPONSE' => '', - 'OPERATOR_BLOCK' => '', - 'OTHERS' => '', - 'SUSPEND' => '', - 'CANCEL' => '', - 'INVALID_NUMBER' => '', - 'UNAVAILABLE' => '', - 'NETWORK_BUSY' => '', - 'NO_ANSWER' => '', - ], - 'example' => 'ANSWERED', - ], + 'schema' => ['description' => 'An ID reserved for the caller. This ID will be returned to the caller in the receipt message. '."\n" + .'It is a string with a length of 1 to 15 bytes.', 'example' => '222356****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'MajorIntent', + 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'A', - ], + 'schema' => ['description' => 'The parameter is not supported yet.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'MinConversationDuration', + 'name' => 'Volume', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The volume for playing user audio. Valid values range from **-4 to 4**. We recommend setting it to **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'MaxConversationDuration', + 'name' => 'Speed', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'This parameter is not currently supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'StartImportedTime', + 'name' => 'AsrModelId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1748948749000', - ], + 'schema' => ['description' => 'ASR model ID. You can view the ASR model ID on the [ASR Model Management page](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4).', 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EndImportedTime', + 'name' => 'AsrBaseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1748948749000', - ], + 'schema' => ['description' => 'ASR foundation model.'."\n" + ."\n" + .'- **customer_service_8k**: Mandarin.'."\n" + .'- **dialect_customer_service_8k**: Heavy accent.'."\n" + ."\n" + .'> - When invoking the **SendCcoSmartCall** API, you must specify an ASR model. We recommend that you provide either the **asrModelId** or **AsrBaseId** parameter.'."\n" + .'- If only **asrModelId** is set, the specified ASR model is used.'."\n" + .'- If only **AsrBaseId** is set, the specified ASR foundation model is used.'."\n" + .'- If neither parameter is set, the default ASR foundation model is used. By default, **AsrBaseId** is **customer_service_8k**, which corresponds to the Mandarin ASR foundation model.'."\n" + .'- If both parameters are set, confirm that they correctly correspond to each other.'."\n", 'example' => 'customer_service_8k', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'StartCallingTime', + 'name' => 'AsrAlsAmId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1748948749000', - ], + 'schema' => ['description' => 'Acoustic model ID.', 'example' => '23387****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EndCallingTime', + 'name' => 'AsrVocabularyId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1748948749000', - ], + 'schema' => ['description' => 'Hotword ID. You can view the ASR hotword ID on the [ASR Hotword Management Page](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi). ', 'example' => '6689****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'RecordFlag', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'Whether to record during the call.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ - 'name' => 'DetailIds', + 'name' => 'PauseTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'Pause duration. Specifies how long the user must pause to indicate the end of a sentence. Unit: milliseconds. Valid range: **300–1200**.'."\n" + ."\n" + .'- If the specified value is outside this range, PauseTime defaults to **800**.'."\n" + .'- Only the first setting takes effect; subsequent settings are ignored.', 'example' => '800', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'MuteTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Silence duration. This parameter defines how long the call waits for user speech before ending the call. The unit is milliseconds, and valid values range from **1000 to 20000**.'."\n" + ."\n" + .'- If the specified value is outside this range, **MuteTime** defaults to **10000**.'."\n" + .'- This parameter can be dynamically updated during the call. The last set value takes effect.', 'example' => '10000', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ActionCodeBreak', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Whether the initial audio playback file is interruptible. The default value is **true**, which means the initial audio playback file can be interrupted. ', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'DynamicId', + 'in' => 'query', + 'schema' => ['description' => 'A dynamic extension ID reserved for the caller, which is returned in the webhook address to serve as the customer\'s developer identity.', 'example' => '2234****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'EarlyMediaAsr', + 'in' => 'query', + 'schema' => ['description' => 'Early media speech recognition identity. When set to **true**, it records the reason why the call was not answered. Default value: **false**, meaning disabled.'."\n" + ."\n" + .'> To enable early media speech recognition, you must manually set this parameter to **true**.', 'example' => 'fasle', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'VoiceCodeParam', + 'in' => 'query', + 'schema' => ['description' => 'TTS parameter string in JSON format. It must correspond to the TTS parameters of VoiceCode.', 'example' => '“{\\”name\\”:\\”喂，你好\\”}”', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'Maximum call duration, in seconds. The call is automatically disconnected after timeout.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'ActionCodeTimeBreak', + 'in' => 'query', + 'schema' => ['description' => 'Interrupts based on the user\'s continuous speaking duration. Takes effect only when ActionCodeBreak is **true**. Unit: milliseconds.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TtsConf', + 'in' => 'query', + 'schema' => ['description' => 'Whether to configure TTS voice parameters.'."\n" + .'- If set to **true**, you must use the TtsStyle, TtsVolume, and TtsSpeed parameters to define the voice style.'."\n" + .'- If set to **false**, related parameters are not required and will have no effect even if configured.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'TtsStyle', + 'in' => 'query', + 'schema' => ['description' => 'Voice style used during TTS variable playback. Default value: **xiaoyun**. For available styles, see the voice style list.', 'example' => 'xiaoyun', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'TtsVolume', + 'in' => 'query', + 'schema' => ['description' => 'The volume for TTS variable playback. Valid values range from **0 to 100**. The default value is **0**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TtsSpeed', + 'in' => 'query', + 'schema' => ['description' => 'Speech speed when playing TTS variables. Valid values range from **-200 to 200**. The default value is **0**. ', 'example' => '100', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'EnableITN', + 'in' => 'query', + 'schema' => ['description' => 'Whether to execute ITN during post-processing. '."\n" + ."\n" + .'> When set to **true**, Chinese numerals are converted to Arabic numerals in the output. The default value is **false**. ', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'default' => 'false', 'title' => ''], + ], + [ + 'name' => 'BackgroundFileCode', + 'in' => 'query', + 'schema' => ['description' => 'ID of the background audio file played during the conversation between the user and the robot. '."\n" + ."\n" + .'You can log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview), choose **Intelligent Interaction > Audio File Management**, and click **View** to check the corresponding audio ID. ', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'BackgroundVolume', + 'in' => 'query', + 'schema' => ['description' => 'The parameter is not supported yet.', 'example' => '1', 'format' => 'int32', 'maximum' => '4', 'minimum' => '-4', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'BackgroundSpeed', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is currently not supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Returned data. ', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ImportedTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748948749000', - ], - 'Status' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '51', - ], - 'Options' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'EncryptionType' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21', - ], - 'CalledNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0537101****', - ], - 'CallResult' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'ConversationTurnCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12121211111*****', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12121211111*****'."\n", - ], - 'MajorIntent' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'A', - ], - 'FailedReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'BranchId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'RecordingFilePath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://*******', - ], - 'CallingTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748948749000', - ], - 'DetailId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12121211111*****'."\n", - ], - 'OutId' => [ - 'type' => 'string', - 'example' => 'outId', - ], - 'BranchVersionId' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'ConversationRecord' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'ConversationDuration' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - ], - ], - 'example' => '', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Unique receipt ID for this call. ', 'example' => '116012854210^10281427****', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5\\",\\n \\"Data\\": {\\n \\"PageSize\\": 5,\\n \\"Total\\": 2,\\n \\"PageNo\\": 60,\\n \\"List\\": [\\n {\\n \\"ImportedTime\\": 1748948749000,\\n \\"Status\\": 4,\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"EncryptionType\\": 1,\\n \\"CalledNumber\\": \\"0537101****\\",\\n \\"CallResult\\": \\"用户接通\\",\\n \\"ConversationTurnCount\\": 10,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"BatchId\\": \\"1183**************\\",\\n \\"MajorIntent\\": \\"A\\",\\n \\"FailedReason\\": \\"账户停机\\",\\n \\"BranchId\\": 49,\\n \\"RecordingFilePath\\": \\"https://*******\\",\\n \\"CallingTime\\": 1748948749000,\\n \\"DetailId\\": \\"9662*************\\",\\n \\"OutId\\": \\"outId\\",\\n \\"BranchVersionId\\": 9,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎，我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好，\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，那我是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了，111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快！再见！\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n }\\\\n]\\",\\n \\"ConversationDuration\\": 100\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"OK\\",\\n \\"Code\\": \\"116012854210^10281427****\\"\\n}","type":"json"}]', + 'title' => 'Initiate an Intelligent Speech Interaction Call ', + 'summary' => 'Invoke the AiccsSmartCall API to initiate an Intelligent Speech Interaction call.'."\n", + 'requestParamsDescription' => '### Voice Style List'."\n" + ."\n" + .'- Xiaoyun Standard Female Voice: xiaoyun '."\n" + .'- Xiaogang Standard Male Voice: xiaogang '."\n" + .'- Ruoxi Gentle Female Voice: ruoxi '."\n" + .'- Xiaomeng Standard Female Voice: xiaomeng '."\n" + .'- Xiaowei Standard Male Voice: xiaowei '."\n" + .'- Amei Sweet Female Voice: amei '."\n" + .'- Xiaoxue Gentle Female Voice: xiaoxue '."\n" + .'- Siqi Gentle Female Voice: siqi '."\n" + .'- Sijia Standard Female Voice: sijia '."\n" + .'- Sicheng Standard Male Voice: sicheng '."\n" + .'- Siyue Gentle Female Voice: siyue '."\n" + .'- Xiaomei Sweet Female Voice: xiaomei '."\n" + .'- Sitong Standard Child Voice: sitong '."\n" + .'- Ning\'er Standard Female Voice: ninger '."\n" + .'- Xiaobei Loli Female Voice: xiaobei '."\n" + .'- Yina Zhejiang-accented Mandarin Female Voice: yina '."\n", + 'changeSet' => [ + ['createdAt' => '2021-06-23T02:52:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'StopAiCallTask' => [ - 'summary' => '停止任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'AiccsSmartCallOperate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1212311111****', - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Unique receipt ID of the call. You can obtain it by invoking [SendCcoSmartCall](~~311247~~).', 'example' => '116012854210^102814279****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the action to be initiated for the called number during an Intelligent outbound call.'."\n" + ."\n" + .'> Currently, only the **parallelBridge** parameter is supported, which indicates bridging the called number with a call center agent.', 'example' => 'parallelBridge', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['description' => 'Extension field.', 'example' => 'Param', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Returned data.', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Result of the command execution. '."\n" + .'- **true**: The command executed successfully. '."\n" + .'- **false**: The command failed to execute.', 'example' => 'true', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"7124F972-BAB8-5D1E-90FC-01CB10713B29\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CancelAiCallDetails' => [ - 'summary' => '批量取消大模型解决方案Ai外呼明细任务', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'Initiate a Specified Action in Intelligent Voice', + 'summary' => 'Invoke the AiccsSmartCallOperate API to initiate a specified action during an Intelligent outbound call. This API is only used for scenarios such as parallel transfer to a human agent or allowing a human agent to listen in on the man-machine dialogue.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AiccsSmartCallOperate'], + ], ], + 'ramActions' => [], + ], + 'AnswerCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1223123123****', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DetailIdList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12131231*****', - ], - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'BatchId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '4253331213*****', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name (agent logon name).', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PhoneNumbers', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '180*******', - ], - 'required' => false, - 'example' => '', - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EncryptionType', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '36', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'FailedDetails' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'FailedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'SucceedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'ResultCode' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'ALL_FAILED' => '', - 'ALL_SUCCEED' => '', - 'PART_FAILED' => '', - ], - 'example' => 'ALL_SUCCEED', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"46C98E28-9239-5D95-AC76-648B8FD4889A\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"FailedDetails\\": {\\n \\"176********\\": \\"明细记录当前状态不可取消\\"\\n },\\n \\"FailedCount\\": 75,\\n \\"SucceedCount\\": 81,\\n \\"ResultCode\\": \\"PART_FAILED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'StartAiCallTask' => [ - 'summary' => '启动任务', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Answer Incoming Call', + 'summary' => 'Invoke AnswerCall to answer an incoming call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'AttachTask' => [ + 'summary' => 'Append job details.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '121212121****', - ], + 'schema' => ['description' => 'The job ID. You can obtain the job ID from the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.', 'example' => '12****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'CallString', + 'in' => 'query', + 'schema' => ['description' => 'The calling string (callee information and parameter list). Valid values:'."\n" + ."\n" + .'- **LIST**: Use this type when the script has no input variables. In this case, only the callee numbers need to be provided. Example: `0571****5678,0571****5679`.'."\n" + .'- **JSON**: Use this type when the script includes input variables. You must provide the variable names, callee numbers, and variable values. Example: `{"ParamNames":["name","age"],"CalleeList":[{"Callee":"181****0000","Params":["Zhang San","20"]},{"Callee":"181****0001","Params":["Li Si","21"]}]}`. **ParamNames** represents the list of parameter names; **Params** represents the list of parameter values.'."\n" + ."\n" + .'> You can view the script input variables on the [**Script Management**](https://aiccs.console.aliyun.com/patter/list) > **View** > **Input and Output Parameters** interface.', 'example' => '{'."\n" + .' "ParamNames": ['."\n" + .' "name",'."\n" + .' "age"'."\n" + .' ],'."\n" + .' "CalleeList": ['."\n" + .' {'."\n" + .' "Callee": "181****0000",'."\n" + .' "Params": ['."\n" + .' "张三",'."\n" + .' "20"'."\n" + .' ]'."\n" + .' },'."\n" + .' {'."\n" + .' "Callee": "181****0001",'."\n" + .' "Params": ['."\n" + .' "李四",'."\n" + .' "21"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4', - ], - 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'false', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'The quantity of successfully appended entries.', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'The request status code. A value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"58A32FFF-86EE-5CF0-B365-97E8C574C7F4\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'UpdateAiCallTask' => [ - 'summary' => '更新AI外呼任务配置', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 10,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Append Details', + 'description' => '- After creating an Intelligent Contact Robot calling job, you can invoke this API to append job details.'."\n" + ."\n" + .'- Before invoking this API, ensure that you already have a successfully created Intelligent Contact Robot calling job.'."\n" + ."\n" + .'- If you do not have a successfully created Intelligent Contact Robot calling job, you can click **Create Job** on the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or create a job by using the [CreateTask](~~2718003~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachTask'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:AttachTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'BatchCreateQualityProjects' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'ProjectName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'VirtualNumber', + 'name' => 'CheckFreqType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '0537022*****', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'StartType', + 'name' => 'TimeRangeStart', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'IMMEDIATE', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'MissCallRetry', + 'name' => 'TimeRangeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CallRetryReason', + 'name' => 'AnalysisIds', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CALL_REJECTED' => '', - 'USER_BUSY' => '', - 'SUSPEND' => '', - 'INVALID_NUMBER' => '', - 'POWERED_OFF' => '', - 'NETWORK_BUSY' => '', - 'NO_ANSWER' => '', - ], - 'example' => 'CALL_REJECTED', - ], - 'required' => false, - ], - ], - [ - 'name' => 'CallRetryTimes', - 'in' => 'query', - 'schema' => [ + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CallRetryInterval', + 'name' => 'InstanceList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '25', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CallTime', + 'name' => 'ChannelTouchType', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}', - ], - 'required' => true, + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'CallDay', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'WEDNESDAY' => '', - 'MONDAY' => '', - 'THURSDAY' => '', - 'SUNDAY' => '', - 'TUESDAY' => '', - 'FRIDAY' => '', - 'SATURDAY' => '', + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'example' => 'MONDAY', + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => true, - ], - ], - [ - 'name' => 'TaskStartTime', - 'in' => 'query', - 'schema' => [ 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1748923429000', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '1152311212312***', - ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CancelAiCallDetails' => [ + 'summary' => 'This operation cancels calls from a call task. You cannot cancel a call if its detail record is already in the pending call queue or is in progress.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TaskCps', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '57', - 'default' => '', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'PhoneType', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '53', - ], + 'schema' => ['description' => 'The task ID. You can view the task ID on the **Call Task Management** page or obtain it by calling the [QueryAiCallTaskPage](~~2926799~~) operation.', 'type' => 'string', 'required' => true, 'example' => '138************'."\n", 'title' => ''], ], [ - 'name' => 'LineEncoding', + 'name' => 'DetailIdList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'A list of detail IDs. If you specify this parameter, `BatchId` and `PhoneNumbers` are ignored.', + 'type' => 'array', + 'items' => ['description' => 'The detail ID. You can find the detail ID in the upper-left corner of the page after you navigate to **Call Task Management** > **Details** > **Execution Record** > **Completed** > **Call Details**, or obtain it by calling the [QueryAiCallDetailPage](~~2926853~~) API.', 'type' => 'string', 'required' => false, 'example' => '12131231*****', 'title' => ''], 'required' => false, - 'example' => '示例值示例值示例值', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'LinePhoneNum', + 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The batch ID. This ID is returned when you import callee data. You can find the task batch ID on the **Call Task Management**>**Details**>**Execution Record** page, or use the import batch ID that is returned by the [ImportTaskNumberDatas](~~2926815~~) API operation. If DetailIdList is specified, this parameter is invalid.', 'type' => 'string', 'required' => false, 'example' => '4253331213*****', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'PhoneNumbers', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'A list of phone numbers. This parameter takes effect only when `BatchId` is also specified.', + 'type' => 'array', + 'items' => ['description' => 'The phone number of the call that you want to cancel. This must be a phone number from the imported callee data.', 'type' => 'string', 'required' => false, 'example' => '180*******', 'title' => ''], 'required' => false, - 'example' => '31', + 'example' => '', + 'title' => '', ], ], ], @@ -2820,396 +1452,261 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '46C98E28-9239-5D95-AC76-648B8FD4889A', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'FailedDetails' => ['description' => 'Details about the failed cancellations. This is a map where the key is the failed detail ID or phone number, and the value is the reason for the failure.', 'type' => 'object', 'example' => '{'."\n" + .' "176********": "明细记录当前状态不可取消"'."\n" + .'}', 'title' => ''], + 'FailedCount' => ['description' => 'The number of calls that could not be canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], + 'SucceedCount' => ['description' => 'The number of calls that were successfully canceled.', 'type' => 'integer', 'format' => 'int64', 'example' => '81', 'title' => ''], + 'ResultCode' => [ + 'description' => 'The result code of the cancellation. Valid values:'."\n" + ."\n" + .'- ALL\\_FAILED: All cancellations failed.'."\n" + ."\n" + .'- ALL\\_SUCCEED: All cancellations succeeded.'."\n" + ."\n" + .'- PART\\_FAILED: Some cancellations failed.', + 'enumValueTitles' => ['ALL_FAILED' => '', 'ALL_SUCCEED' => '', 'PART_FAILED' => ''], + 'type' => 'string', + 'example' => 'PART_FAILED', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"FCD94A7F-316D-54D1-9BFC-814006CB1C34\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'QueryAiCallTaskPage' => [ - 'summary' => '查询任务列表', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"46C98E28-9239-5D95-AC76-648B8FD4889A\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"FailedDetails\\": {\\n \\"176********\\": \\"明细记录当前状态不可取消\\"\\n },\\n \\"FailedCount\\": 75,\\n \\"SucceedCount\\": 81,\\n \\"ResultCode\\": \\"PART_FAILED\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Cancel Calls for Communication Agent Call Jobs ', + 'description' => '- Use this operation to cancel calls. Alternatively, you can manually cancel calls in the console by navigating to **Call Task Management** > **Manage** > **Execution Records** > **Pending**.'."\n" + ."\n" + .'- Before calling this operation, ensure you have created a call task and imported callee data.'."\n" + ."\n" + .'- If you have not created a call task, you can create one and import callee data on the **Call Task Management** page. You can also call the [CreateAiCallTask](~~2926815~~) and [ImportTaskNumberDatas]() operations.'."\n" + ."\n" + .'- Canceling a call task may affect your business. Please proceed with caution.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAiCallDetails'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:CancelAiCallDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CancelTask' => [ + 'summary' => 'Cancel an Intelligent Contact Robot calling job.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNo', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The unique job ID of the robot calling task. You can view it in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or obtain it by using the [CreateTask](~~223556~~) API.'."\n", 'example' => '12****', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - 'default' => '10', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'Request status code. A value of OK indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Cancel Job'."\n", + 'description' => '- You can invoke this API to cancel an Intelligent Contact Robot calling job, or manually cancel the job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.'."\n" + ."\n" + .'- After an Intelligent Contact Robot calling job is canceled, it cannot be started again. Proceed with caution.'."\n" + ."\n" + .'- If you want to pause a job and restart it later, you can manually pause the job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or pause it by using the [StopTask](~~2718006~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'ramActions' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'INIT' => '', - 'FAILED' => '', - 'RUNNING' => '', - 'STOPPED' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:CancelTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'example' => 'INIT', ], ], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'ChangeChatAgentStatus' => [ + 'summary' => 'Invoke ChangeChatAgentStatus to modify the Live Support status.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'AgentName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '112212312*****', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ApplicationCode', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account.', 'example' => 'account1', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Source', - 'in' => 'query', + 'name' => 'Method', + 'in' => 'formData', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '68', + 'description' => 'The target online status to switch to. Currently, only **requestLogout** (request offline) is supported.', + 'example' => 'requestLogout', + 'required' => true, + 'title' => '', + 'type' => 'string', + 'enum' => ['requestRest', 'requestLogout', 'restToWork'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'B99C5955-5664-573D-97BE-A7CC1AFD8401', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37', - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '', - '', - '', - '', - ], - 'example' => '1', - ], - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => '11121221121*****', - ], - 'CompleteRate' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'double', - 'example' => '70%', - ], - 'ApplicationName' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'CreateTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748932499000', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748932499000', - ], - 'RealStartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748932499000', - ], - 'TotalCallCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '58', - ], - 'DayCallCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'ApplicationCode' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '71', - ], - 'TaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'StartFailedReason' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'FailedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '61', - ], - 'AgentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallingCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72', - ], - 'AgentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11213132123123*****', - ], - 'SucceedCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '36', - ], - 'DayImportCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '400', - ], - 'ConcurrentCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'HistoryConnectRate' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'double', - 'example' => '95.89%', - ], - 'DayConnectRate' => [ - 'description' => '', - 'type' => 'string', - 'format' => 'double', - 'example' => '74.14%', - ], - ], - ], - 'example' => '', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'success', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'DF6A3FB7-A5AA-43BE-A65B', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], + 'Data' => ['description' => 'Current agent status. Valid values:'."\n" + .'- **0**: Offline'."\n" + .'- **3**: On break', 'example' => '0', 'title' => 'data', 'type' => 'string'], + 'Code' => ['description' => 'Status code.', 'example' => 'Success', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], + 'title' => 'result', + 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"B99C5955-5664-573D-97BE-A7CC1AFD8401\\",\\n \\"Data\\": {\\n \\"PageSize\\": 74,\\n \\"Total\\": 72,\\n \\"PageNo\\": 37,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"CompleteRate\\": \\"70%\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"CreateTime\\": 1748932499000,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"TotalCallCount\\": 58,\\n \\"DayCallCount\\": 22,\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"TotalCount\\": 71,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"StartFailedReason\\": \\"智能体不在线\\",\\n \\"FailedCount\\": 61,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"CallingCount\\": 72,\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"SucceedCount\\": 36,\\n \\"DayImportCount\\": 400,\\n \\"ConcurrentCount\\": 10,\\n \\"HistoryConnectRate\\": \\"95.89%\\",\\n \\"DayConnectRate\\": \\"74.14%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryAiCallTaskDetail' => [ - 'summary' => '查询任务详情', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify Live Support Status', + 'description' => '> Currently, only changing the Live Support status to offline is supported.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeChatAgentStatus'], + ], ], + ], + 'ChangeQualityProjectStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '112123123******', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -3217,347 +1714,176 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '11121232222****', - ], - 'ApplicationName' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'RetryEnable' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748932499000', - ], - 'RealStartTime' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1748932499000', - ], - 'LinePhoneNum' => [ - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'ApplicationCode' => [ - 'type' => 'string', - 'example' => '示例值', - ], - 'CallerNumber' => [ - 'description' => '', - 'type' => 'string', - 'example' => '05370124****', - ], - 'CallTimes' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '09:00:00', - ], - 'StartTime' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12:00:00', - ], - ], - ], - 'example' => '', - ], - 'RetryReasons' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'CALL_REJECTED' => '', - 'USER_BUSY' => '', - 'SUSPEND' => '', - 'INVALID_NUMBER' => '', - 'POWERED_OFF' => '', - 'NETWORK_BUSY' => '', - 'NO_ANSWER' => '', - ], - 'example' => 'CALL_REJECTED', - ], - 'example' => '', - ], - 'RetryCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PhoneType' => [ - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17', - ], - 'TaskName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'LineEncoding' => [ - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'StartType' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'SCHEDULE' => '', - 'IMMEDIATE' => '', - ], - 'example' => 'IMMEDIATE', - ], - 'AgentName' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AgentId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RetryInterval' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CallDays' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'enumValueTitles' => [ - 'WEDNESDAY' => '', - 'MONDAY' => '', - 'THURSDAY' => '', - 'SUNDAY' => '', - 'TUESDAY' => '', - 'FRIDAY' => '', - 'SATURDAY' => '', - ], - 'example' => 'MONDAY', - ], - 'example' => '', - ], - 'ConcurrentCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数无效\\",\\n \\"RequestId\\": \\"23822ECB-8CAA-5C52-9C9E-807FD82A5A7F\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1187**************\\\\n\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"RetryEnable\\": true,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"LinePhoneNum\\": \\"示例值\\",\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"CallerNumber\\": \\"05370124****\\",\\n \\"CallTimes\\": [\\n {\\n \\"EndTime\\": \\"09:00:00\\",\\n \\"StartTime\\": \\"12:00:00\\"\\n }\\n ],\\n \\"RetryReasons\\": [\\n \\"CALL_REJECTED\\"\\n ],\\n \\"RetryCount\\": 2,\\n \\"PhoneType\\": 17,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"LineEncoding\\": \\"示例值\\",\\n \\"StartType\\": \\"IMMEDIATE\\",\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"RetryInterval\\": 1,\\n \\"CallDays\\": [\\n \\"MONDAY\\"\\n ],\\n \\"ConcurrentCount\\": 10\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'ImportTaskNumberDatas' => [ - 'summary' => '导入任务号码数据', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateAgent' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '268865', - 'abilityTreeNodes' => [ - 'FEATUREaiccsTY5M4L', - ], + 'abilityTreeCode' => '15515', + 'abilityTreeNodes' => ['FEATUREaiccsDTMAFT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'OssFileName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '123dsdfsdfsdf.xlsx', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. It can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '12131213132123*****', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PhoneNumberList', + 'name' => 'AccountName', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "age": "18",'."\n" - .' "calleeNumber": "0534556****",'."\n" - .' "name": "Tom",'."\n" - .' "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E"'."\n" - .'}', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DataType', - 'in' => 'query', + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'Display name of the agent. ', 'docRequired' => true, 'example' => 'XX测试', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'JSON', - 'enum' => [ - 'EXCEL', - 'JSON', - ], + 'description' => 'ID of the skill group to which the agent belongs. ', + 'format' => 'int64', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '1234****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EncryptionType', - 'in' => 'query', + 'name' => 'SkillGroupIdList', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'type' => 'integer', + 'description' => 'List of skill group IDs to which the agent belongs.', 'format' => 'int64', - 'example' => '1', + 'items' => ['description' => 'List of skill group IDs.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '1223****,1456****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1223123132123*****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Agent ID. ', 'example' => '2578****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded. ', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['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' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CFC2F07E-F763-7C48-1A32-6EFFB6EA344E\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CreateAiCallTask' => [ - 'summary' => '创建任务', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create Agent ', + 'summary' => 'Create an agent account in the Cloud Customer Service System and return the agent ID. ', + 'description' => '- Before calling this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify skill group information, refer to the guidance in [Request Parameters](#api-detail-35). '."\n" + .'- You can manage agents by calling [DeleteAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-deleteagent) to delete an agent or [UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent) to update agent data. '."\n" + ."\n" + .'### QPS Limit'."\n" + .'- Per-user call frequency: No rate limiting. '."\n" + .'- API call frequency: 100 queries per second (QPS). '."\n" + ."\n" + .'> If the total calls from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [ + ['createdAt' => '2025-05-13T03:55:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:CreateAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CreateAiCallTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -3570,9 +1896,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '268866', - 'abilityTreeNodes' => [ - 'FEATUREaiccsTY5M4L', - ], + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], @@ -3580,119 +1904,106 @@ [ 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The name of the task. It must be unique within an account.', 'type' => 'string', 'required' => true, 'example' => '测试任务', 'title' => ''], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '121223123123****', - ], + 'schema' => ['description' => 'The ID of a published agent.', 'type' => 'string', 'required' => false, 'example' => '1180**************'."\n", 'title' => ''], ], [ 'name' => 'VirtualNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '032712122*****', - ], + 'schema' => ['description' => 'The service instance used for outbound calls.', 'type' => 'string', 'required' => false, 'example' => '032712122*****', 'title' => ''], ], [ 'name' => 'StartType', 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The startup mode. Valid values:'."\n" + ."\n" + .'- `IMMEDIATE`: Starts the task immediately.'."\n" + ."\n" + .'- `SCHEDULE`: Starts the task at a scheduled time.', + 'enumValueTitles' => ['SCHEDULE' => '', 'IMMEDIATE' => ''], 'type' => 'string', 'required' => true, - 'enumValueTitles' => [ - 'SCHEDULE' => '', - 'IMMEDIATE' => '', - ], 'example' => 'SCHEDULE', + 'title' => '', ], ], [ 'name' => 'MissCallRetry', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'Specifies whether to enable retry. Valid values:'."\n" + ."\n" + .'- `true`: Enables retry.'."\n" + ."\n" + .'- `false` (default): Disables retry.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], ], [ 'name' => 'CallRetryReason', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The failure reasons that trigger a retry.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The specific reason for the retry. Valid values:'."\n" + ."\n" + .'- `CALL_REJECTED`: Call rejection.'."\n" + ."\n" + .'- `USER_BUSY`: User busy.'."\n" + ."\n" + .'- `SUSPEND`: Suspended service.'."\n" + ."\n" + .'- `INVALID_NUMBER`: Invalid number.'."\n" + ."\n" + .'- `POWERED_OFF`: Powered off.'."\n" + ."\n" + .'- `NETWORK_BUSY`: Network busy.'."\n" + ."\n" + .'- `NO_ANSWER`: No answer.', + 'enumValueTitles' => ['CALL_REJECTED' => '', 'USER_BUSY' => '', 'SUSPEND' => '', 'INVALID_NUMBER' => '', 'POWERED_OFF' => '', 'NETWORK_BUSY' => '', 'NO_ANSWER' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'CALL_REJECTED' => '', - 'USER_BUSY' => '', - 'SUSPEND' => '', - 'INVALID_NUMBER' => '', - 'POWERED_OFF' => '', - 'NETWORK_BUSY' => '', - 'NO_ANSWER' => '', - ], 'example' => 'CALL_REJECTED', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'CallRetryTimes', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The number of retries. The maximum value is 3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ 'name' => 'CallRetryInterval', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '32', - ], + 'schema' => ['description' => 'The retry interval, in minutes. The maximum value is 720.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', 'title' => ''], ], [ 'name' => 'CallTime', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of callable time periods.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n", - ], - 'required' => true, + 'items' => ['description' => 'The callable time period, in the following JSON format:'."\n" + ."\n" + .'```json'."\n" + .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n" + .'```'."\n" + ."\n" + .'The system makes outbound calls only during this period. If the current time is outside the specified period, the system waits for the next callable period.'."\n" + ."\n" + .'> - In compliance with carrier policies, the actual execution time is subject to platform scheduling. You can view the restricted calling periods for your numbers in [Real Number Management](https://dyvms.console.aliyun.com/number/list/normal).', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}'."\n", 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ @@ -3700,102 +2011,69 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of callable days.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The callable day. Valid values:'."\n" + ."\n" + .'- `MONDAY`: Monday.'."\n" + ."\n" + .'- `TUESDAY`: Tuesday.'."\n" + ."\n" + .'- `WEDNESDAY`: Wednesday.'."\n" + ."\n" + .'- `THURSDAY`: Thursday.'."\n" + ."\n" + .'- `FRIDAY`: Friday.'."\n" + ."\n" + .'- `SATURDAY`: Saturday.'."\n" + ."\n" + .'- `SUNDAY`: Sunday.', + 'enumValueTitles' => ['WEDNESDAY' => '', 'MONDAY' => '', 'THURSDAY' => '', 'SUNDAY' => '', 'TUESDAY' => '', 'FRIDAY' => '', 'SATURDAY' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'WEDNESDAY' => '', - 'MONDAY' => '', - 'THURSDAY' => '', - 'SUNDAY' => '', - 'TUESDAY' => '', - 'FRIDAY' => '', - 'SATURDAY' => '', - ], 'example' => 'MONDAY', + 'title' => '', ], 'required' => true, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'TaskStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12313123133', - ], + 'schema' => ['description' => 'The scheduled start time for the task, specified as a timestamp in milliseconds. This parameter is required and applies only when `StartType` is set to `SCHEDULE`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12313123133', 'title' => ''], ], [ 'name' => 'TaskCps', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '75', - ], + 'schema' => ['description' => 'The task concurrency. The maximum value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75', 'title' => ''], ], [ 'name' => 'Source', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'description' => '', 'title' => ''], ], [ 'name' => 'ApplicationCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - ], - [ - 'name' => 'ApplicationName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => '025****C98', 'description' => '', 'title' => ''], ], [ 'name' => 'PhoneType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '54', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'description' => '', 'title' => ''], ], [ 'name' => 'LineEncoding', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => 'JILIANG_***_***_NET', 'description' => '', 'title' => ''], ], [ 'name' => 'LinePhoneNum', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['type' => 'string', 'required' => false, 'example' => '152****3120', 'description' => '', 'title' => ''], ], ], 'responses' => [ @@ -3803,340 +2081,421 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1213123123*****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8C93B345-F702-5449-BA7E-7D110D4BF798', 'title' => ''], + 'Data' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1213123123*****', 'title' => ''], + 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- **true**: The call succeeded.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create an outbound calling job for the Communication Intelligent Agent', + 'summary' => 'Creates a call task.', + 'description' => 'Before creating a call task, make a test call with an agent to ensure the results meet your requirements.', + 'changeSet' => [ + ['createdAt' => '2025-12-24T09:12:26.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2025-12-24T08:27:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8C93B345-F702-5449-BA7E-7D110D4BF798\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'LlmSmartCall' => [ - 'summary' => '基于大模型的智能外呼', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateAiOutboundTask' => [ + 'summary' => 'Create an Intelligent Outbound Call Job. You can configure the Task Type, job name, outbound caller ID, callee number deduplication policy, and other settings when creating the job.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '256802', - 'abilityTreeNodes' => [ - 'FEATUREaiccsA3JJUR', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CalledNumber', + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'cc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Task Type. Valid values: '."\n" + .'- **2**: Predictive outbound call. '."\n" + .'- **3**: Automated outbound call.', + 'example' => '2', + 'format' => 'int32', 'required' => true, - 'example' => '137****0000', + 'title' => '', + 'type' => 'integer', + 'enum' => ['2', '3'], ], ], [ - 'name' => 'CallerNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '057188040000', - ], + 'schema' => ['description' => 'Job name. Length: 1 to 15 characters.', 'example' => '测试任务', 'maxLength' => 15, 'minLength' => 1, 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ApplicationCode', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'F32XXX2CF9', - ], + 'schema' => ['description' => 'Job description. Length: 0 to 100 characters.', 'example' => '房产销售', 'maxLength' => 100, 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'StartWordParam', + 'name' => 'OutboundNums', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, + 'description' => 'Outbound caller numbers. '."\n" + ."\n" + .'> Must be purchased numbers. Separate multiple numbers with commas (,).', + 'items' => ['description' => 'Outbound caller numbers. '."\n" + ."\n" + .'> Must be purchased numbers. Separate multiple numbers with commas (,).', 'example' => '["0571****5678","0571****5678"]', 'required' => true, 'type' => 'string', 'title' => ''], + 'required' => true, + 'title' => '', + 'type' => 'array', 'example' => '', ], ], [ - 'name' => 'PromptParam', + 'name' => 'NumRepeated', 'in' => 'query', - 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', + 'description' => 'Called number deduplication policy. Valid values:'."\n" + .'- **0**: Remove duplicates within the job.'."\n" + .'- **1**: Do not remove duplicates.', + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'title' => '', + 'type' => 'integer', + 'enum' => ['0', '1'], ], ], [ - 'name' => 'OutId', + 'name' => 'HandlerId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '222356****', - 'maxLength' => 32, - ], + 'schema' => ['description' => 'The skill group ID (for predictive outbound calls) or IVR ID (for automated outbound calls). You can obtain this information in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'BizParam', + 'name' => 'ExecutionTime', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'type' => 'object', - ], + 'schema' => ['description' => 'Job execution time, in JSON format.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Extension', + 'name' => 'ConcurrentRate', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'maxLength' => 5, - ], + 'schema' => ['description' => 'Concurrent call rate for automated outbound calls.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'SessionTimeout', + 'name' => 'RecallRule', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Failed call retry policy. '."\n" + ."\n" + .'> If empty, no retries are performed.', + 'properties' => [ + 'Count' => ['description' => 'Number of retries. Valid values: **1 to 3**.', 'example' => '1', 'format' => 'int32', 'maximum' => '3', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], + 'Interval' => ['description' => 'Retry interval. Valid values: **1 to 60**, unit: minutes.', 'example' => '1', 'format' => 'int32', 'maximum' => '60', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], + ], 'required' => false, - 'maximum' => '3600', - 'minimum' => '300', + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], [ - 'name' => 'TtsVoiceCode', + 'name' => 'ForecastCallRate', 'in' => 'query', + 'schema' => ['description' => 'Fixed outbound ratio for predictive dialing. Valid values: **≥1**.', 'example' => '1.5', 'format' => 'float', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'number'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', + 'description' => 'Returned data.', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Job ID.', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'Request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create Intelligent Outbound Call Job', + 'description' => '- The **Data** field in the response parameters of this API is the job ID. '."\n" + .'- After creating an Intelligent Outbound Call Job, if you need to make updates, you can invoke the [UpdateAiOutboundTask](~~2718021~~) API to update the outbound call job.'."\n" + ."\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No Rate Limiting.'."\n" + .'- API frequency: 20 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'CreateAiOutboundTaskBatch' => [ + 'summary' => 'Creates a batch for an Intelligent Outbound Calling job based on the instance ID and job ID, enabling data under the job to be queried by batch.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TtsSpeed', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'TtsVolume', + 'name' => 'TaskId', 'in' => 'query', + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and view the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and view the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'The version ID of the newly created job batch.', 'example' => '123456', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'The request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a batch for an Intelligent Outbound Calling job', + 'description' => 'Before invoking this API, we recommend that you confirm the instance ID and job ID. For guidance on how to obtain them, see the instructions in [Request Parameters](#api-detail-35).'."\n" + .'### QPS limit'."\n" + .'- Per-user invocation frequency: 20 queries per second (QPS).'."\n" + .'- API-wide invocation frequency: 20 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAiOutboundTaskBatch'], + ], + ], + 'ramActions' => [], + ], + 'CreateDepartment' => [ + 'summary' => 'Creates department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department name. Upon successful creation, the department ID is returned.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'CustomerLineCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'DepartmentName', + 'in' => 'query', + 'schema' => ['description' => 'Department name.', 'example' => '部门A', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', - 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-XX13-B165', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'CallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '125165515***^11195613****', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Department ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ModelStatus.Invalid', - 'errorMessage' => 'Model state invalid.', - ], - [ - 'errorCode' => 'MissingParameter.CallerNumber', - 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', - ], - [ - 'errorCode' => 'InvalidParameter.ApplicationCode', - 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', - ], - [ - 'errorCode' => 'ModelNotExist', - 'errorMessage' => 'The model does not exist.', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create Department Information', + 'description' => '- If you need to update department information, you can invoke the [UpdateDepartment](~~2717977~~) API.'."\n" + .'- After successfully creating department information by invoking this API, the **Data** field in the response contains the department ID. If you need to query the department ID later, you can invoke the [GetAllDepartment](~~2717975~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second.'."\n" + .'- API invocation frequency: 100 times/second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]', - ], - 'LlmSmartCallEncrypt' => [ - 'summary' => '大模型外呼加密号码接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDepartment'], + ], ], + 'ramActions' => [], + ], + 'CreateOutboundTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '270332', - 'abilityTreeNodes' => [ - 'FEATUREaiccs6AMUI3', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'EncryptCalledNumber', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '140432432432243', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PromptParam', + 'name' => 'TaskName', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{}', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'StartWordParam', + 'name' => 'Description', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ApplicationCode', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ADDFA32145', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CallerNumber', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ADDFA32145', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OutId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dsadsaasfdsad', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'RetryTime', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '3', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'RetryInterval', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2880', 'minimum' => '0', 'default' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SkillGroup', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Ani', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Model', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '10', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ExtAttrs', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CallInfos', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -4144,59 +2503,36 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '149922088206^136666368206', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'ok', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F92F9749-105E-518F-8B08-CF16EF36A0E2\\",\\n \\"Data\\": {\\n \\"CallId\\": \\"149******206\\"\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'HangupOperate' => [ - 'summary' => '通信智能引擎中主动挂断通话', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateQualityProject' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4204,119 +2540,195 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '259150', - 'abilityTreeNodes' => [ - 'FEATUREaiccsA3JJUR', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CallId', - 'in' => 'query', - 'allowEmptyValue' => false, + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CheckFreqType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ScopeType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TimeRangeStart', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TimeRangeEnd', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ChannelTouchType', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 3, 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '147776727911^134522727911', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImmediateHangup', - 'in' => 'query', + 'name' => 'DepList', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 3, 'description' => '', - 'type' => 'boolean', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'GroupList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, - 'example' => 'true', - 'default' => 'true', + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ServicerList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AnalysisIds', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Mesage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Result' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.CallId', - 'errorMessage' => 'The parameter CallId is invalid.', - ], + 500 => [ + ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]', - ], - 'ListAvailableTts' => [ - 'summary' => '获取tts音色列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateQualityRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '273987', - 'abilityTreeNodes' => [ - 'FEATUREaiccsTY5M4L', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TtsVoiceCode', - 'in' => 'query', + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'RuleTag', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MatchType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'KeyWords', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'title' => '复刻音色编码', - 'description' => '复刻音色编码', - 'type' => 'string', - 'required' => false, - 'example' => 'V123456789', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], @@ -4325,884 +2737,571 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'RequestId' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => '5EBAEBE6-0E77-5E1F-99E4-7B20512F22222', - ], - 'Message' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Data' => [ - 'title' => '', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TtsVoiceName' => [ - 'title' => '音色名称', - 'description' => '音色名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TtsEngine' => [ - 'title' => '音色平台CosyVoice/Volcano', - 'description' => '音色平台CosyVoice/Volcano', - 'type' => 'string', - 'example' => 'CosyVoice/Volcano', - ], - 'TtsStyle' => [ - 'title' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX', - 'description' => '音色cosy类型 cosyvoice-v2-XXXX-XXXX', - 'type' => 'string', - 'example' => '5EBAEBE6-0E77-5E1F-99E4-7B20512FCB3C', - ], - 'TtsAuditionFileUrl' => [ - 'title' => '音色试听文件', - 'description' => '音色试听文件', - 'type' => 'string', - 'example' => '示例值', - ], - 'TtsVoiceCode' => [ - 'title' => '音色编码', - 'description' => '音色编码', - 'type' => 'string', - 'example' => 'V123456789', - ], - ], - 'enumValueTitles' => [], - ], - 'example' => '', - ], - 'Code' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'title' => '', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"5EBAEBE6-0E77-5E1F-99E4-7B20512F22222\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TtsVoiceName\\": \\"龙小夏\\",\\n \\"TtsEngine\\": \\"CosyVoice\\",\\n \\"TtsStyle\\": \\"cosyvoice-v2-*********-*******\\",\\n \\"TtsAuditionFileUrl\\": \\"https://*******/longxiaoxia.mp3\\",\\n \\"TtsVoiceCode\\": \\"V9A******\\\\n\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'GetCallDialogContent' => [ - 'summary' => '查询对话内容', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'CreateSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '275547', - 'abilityTreeNodes' => [ - 'FEATUREaiccsA3JJUR', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CallDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '2025-06-06', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '123456^123478', - ], + 'name' => 'SkillGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'Skill group name.', 'docRequired' => true, 'example' => '在线自动化技能组', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Skill group description.', 'example' => '在线自动化技能组', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'External display name of the skill group.', 'example' => '在线自动化技能组', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => ['description' => 'Channel type of the skill group. Valid values:'."\n" + ."\n" + .'- **1**: Hotline.'."\n" + .'- **2**: Online.'."\n" + .'- **3**: Ticket.', 'docRequired' => true, 'example' => '2', 'format' => 'int32', 'maximum' => '7', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'formData', + 'schema' => ['description' => 'Department ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DialogContent' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '123456^123478'."\n", - ], - 'CallStatus' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'OK', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'ID of the successfully created skill group.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.CallId', - 'errorMessage' => 'The parameter CallId is invalid.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"RequestId\\": \\"FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"DialogContent\\": \\"[{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"您好。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"assistant\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"不用了。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呃，不用了，再见，谢谢。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"}]\\",\\n \\"CallId\\": \\"123456^123478\\\\n\\",\\n \\"CallStatus\\": 2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => ''], + ['errorMessage' => 'The specified department is unavailable or does not exist.', 'errorCode' => 'Department.NotFound', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a Skill Group', + 'summary' => 'Create a skill group based on the skill group name and channel type.', + 'description' => '- This API allows you to define information such as the external display name and description of the skill group. For details, see [Request Parameters](#api-detail-35).'."\n" + .'- The **Data** parameter returned by this API is the ID of the successfully created skill group.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 1000 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetHotlineServiceStatistics' => [ - 'summary' => '服务统计量数据', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateTask' => [ + 'summary' => 'Create an Artificial Intelligence Cloud Call Service robot outbound calling job.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'Task Name. Supports Chinese and English characters. Length: 0 to 30 characters.', 'example' => '测试任务', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'RobotId', 'in' => 'query', - 'schema' => [ - 'title' => '开始日期时间戳（毫秒）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1615083365000', - ], + 'schema' => ['description' => 'ID of the specified robot (script ID), indicating which robot script to use for initiating calls. '."\n" + ."\n" + .'You can obtain the script ID on the [Script Management](https://aiccs.console.aliyun.com/patter/list) page in the console.'."\n", 'example' => '12****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'Caller', 'in' => 'query', - 'schema' => [ - 'title' => '结束日期时间戳（毫秒）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1617761765000', - ], + 'schema' => ['description' => 'Outbound caller number.'."\n" + ."\n" + .'> The number must be a purchased number. Separate multiple numbers with commas (,).', 'example' => '0571****5678,0571****5679', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'CallString', 'in' => 'query', - 'schema' => [ - 'title' => '每页大小（默认为10)', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Call string (callee information and parameter list). Valid values:'."\n" + ."\n" + .'- **LIST**: `05715678****,05715679****`'."\n" + .'- **JSON**: `{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["Zhang San","20"]},{"Callee":"1810001****","Params":["Li Si","21"]}]}`. In this example, ParamNames represents the List of Parameter Names; Params represents the List of parameter values.'."\n" + ."\n" + .'> - The order of the Parameter Name List and the parameter value List must correspond. '."\n" + .'- A maximum of 1 000 callee numbers is allowed.'."\n", 'example' => '{"ParamNames":["name","age"],"CalleeList":[{"Callee":"1810000****","Params":["张三","20"]},{"Callee":"1810001****","Params":["李四","21"]}]}', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'CallStringType', 'in' => 'query', - 'schema' => [ - 'title' => '当前页（默认为1）', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Call string type. Valid values: '."\n" + .'- **LIST** '."\n" + .'- **JSON**'."\n", 'example' => 'JSON', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'AgentIds', + 'name' => 'RetryFlag', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '坐席id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '111', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Whether to enable automatic retry. Valid values:'."\n" + ."\n" + .'- **1**: Retry.'."\n" + .'- **0**: No retry.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'DepIds', + 'name' => 'RetryCount', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '部门id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Retry Count.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'RetryInterval', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '技能组id列表', - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'required' => false, - ], + 'schema' => ['description' => 'Retry interval. Unit: minute. Must be greater than 1.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'TimeLatitudeType', + 'name' => 'RetryStatusCode', 'in' => 'query', - 'schema' => [ - 'title' => '时间纬度类型', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'minute', - ], + 'schema' => ['description' => 'Call statuses that require redialing. Separate multiple statuses with commas (,). Valid values: '."\n" + .'- **200010**: Power off '."\n" + .'- **200011**: Service suspended '."\n" + .'- **200002**: Busy '."\n" + .'- **200012**: Call failed '."\n" + .'- **200005**: Unable to connect '."\n" + .'- **200003**: No acknowledgement'."\n", 'example' => '200010,200011', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistAgentGrouping', + 'name' => 'StartNow', 'in' => 'query', - 'schema' => [ - 'title' => '是否根据坐席分组', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Indicates whether to start immediately. '."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.'."\n", 'example' => '是', 'required' => false, 'type' => 'boolean', 'default' => 'false', 'title' => ''], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'WorkTimeList', 'in' => 'query', - 'schema' => [ - 'title' => '是否根据部门分组', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'List of working hours (accurate to the minute).'."\n", 'example' => '10:00-12:00,13:00-14:00', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistSkillGroupGrouping', + 'name' => 'WorkDay', 'in' => 'query', - 'schema' => [ - 'title' => '是否根据技能组分组', - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'Work day. Valid values:'."\n" + ."\n" + .'- **1**: Monday.'."\n" + .'- **2**: Tuesday.'."\n" + .'- **3**: Wednesday.'."\n" + .'- **4**: Thursday.'."\n" + .'- **5**: Friday.'."\n" + .'- **6**: Saturday.'."\n" + .'- **7**: Sunday.'."\n", 'example' => '1', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SeatCount', + 'in' => 'query', + 'schema' => ['description' => 'Concurrency (number of agents).', 'example' => '3', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'Schema of Response', - 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID，用于跟踪错误原因', - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], - 'Message' => [ - 'title' => '错误描述', - 'description' => '', - 'type' => 'string', - 'example' => 'message', - ], - 'Data' => [ - 'title' => 'data', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalNum' => [ - 'title' => '总记录数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PageNum' => [ - 'title' => '当前页数', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '页大小', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2000', - ], - 'Rows' => [ - 'title' => '信息为list<map>类型的json字符串', - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - 'Code' => [ - 'title' => '错误编码', - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'title' => '调用接口是否成功', - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Unique job ID of the robot outbound calling task.'."\n", 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineServiceStatisticsResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>xxxx</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>{\\"tenant_id\\":\\"905\\",\\"n_resttype_now\\":0,\\"tenant_name\\":\\"非单元测试化BU\\",\\"n_resttype1_now\\":0,\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"n_resttype98_now\\":0,\\"n_online_now\\":0,\\"date_id\\":\\"20210401\\",\\"n_resttype3_now\\":0,\\"n_resttype5_now\\":0,\\"n_busy_now\\":0,\\"n_resttype2_now\\":0,\\"group_id\\":\\"-1\\",\\"n_idle_now\\":0,\\"n_resttype4_now\\":0,\\"n_ack_now\\":0,\\"n_resttype99_now\\":0}</Rows>\\n </Data>\\n</GetHotlineServiceStatisticsResponse>","errorExample":""}]', - 'title' => 'GetHotlineServiceStatistics', - ], - 'GetSkillGroupAndAgentStatusSummary' => [ - 'summary' => '技能组坐席汇总状态量', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create Job'."\n", + 'description' => '- You can invoke this API to create a job, or create one in the **Artificial Intelligence Cloud Call Service console** > **Outbound Robot (Standard Edition)** > [Task Management](https://aiccs.console.aliyun.com/job/list) by clicking **Create Job**. '."\n" + .'- After invoking this API, the **Data** field in the response contains the unique job ID of the robot outbound calling task.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:CreateTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateThirdSsoAgent' => [ + 'summary' => 'Create an agent that enables password-free login to the Cloud Customer Service System based on a User Account.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => 'param1', 'type' => 'string'], ], [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'name' => 'ClientId', + 'in' => 'formData', + 'schema' => ['description' => 'The client ID issued to the tenant instance.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => true, 'title' => 'param2', 'type' => 'string'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'name' => 'AccountId', + 'in' => 'formData', + 'schema' => ['description' => 'Account ID to synchronize.', 'example' => 'accountId1', 'required' => true, 'title' => 'param3', 'type' => 'string'], ], [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Account name to synchronize.', 'example' => 'accountName1', 'required' => true, 'title' => 'param4', 'type' => 'string'], ], [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent display name.', 'example' => '张三', 'required' => false, 'title' => 'param5', 'type' => 'string'], ], [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'SkillGroupIds', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID. '."\n" + .'> The specified skill groups must belong to the same skill group group.', 'example' => '1', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '技能组id列表', + 'title' => 'param6', 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'ExistDepartmentGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'ExistSkillGroupGrouping', - 'in' => 'query', + 'name' => 'RoleIds', + 'in' => 'formData', + 'style' => 'flat', 'schema' => [ - 'description' => '', - 'example' => 'false', + 'description' => 'List of role IDs.', + 'items' => ['description' => 'Role ID.', 'example' => '1', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', + 'title' => 'param7', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'message', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '每页的数量', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'Success', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'requestId', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => 'httpStatusCode', 'type' => 'integer'], + 'Data' => ['description' => 'The ID of the created agent.', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'Status code.', 'example' => '200', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], - 'title' => 'Schema of Response', + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupAndAgentStatusSummaryResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>message</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>{\\"tenant_id\\":\\"905\\",\\"n_resttype_now\\":0,\\"tenant_name\\":\\"非单元测试化BU\\",\\"n_resttype1_now\\":0,\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"n_resttype98_now\\":0,\\"n_online_now\\":0,\\"date_id\\":\\"20210401\\",\\"n_resttype3_now\\":0,\\"n_resttype5_now\\":0,\\"n_busy_now\\":0,\\"n_resttype2_now\\":0,\\"group_id\\":\\"-1\\",\\"n_idle_now\\":0,\\"n_resttype4_now\\":0,\\"n_ack_now\\":0,\\"n_resttype99_now\\":0}</Rows>\\n </Data>\\n</GetSkillGroupAndAgentStatusSummaryResponse>","errorExample":""}]', - 'title' => 'GetSkillGroupAndAgentStatusSummary', - ], - 'GetDepartmentalLatitudeAgentStatus' => [ - 'summary' => '部门纬度坐席状态量', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create an agent for password-free login to the Cloud Customer Service System', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'], + ], ], + 'ramActions' => [], + ], + 'DeleteAgent' => [ + 'summary' => 'Deletes an agent account in the Cloud Customer Service System based on the instance ID and agent account name.', + 'methods' => ['delete'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '15536', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298****', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'StartDate', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'AccountName', 'in' => 'query', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox specified during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'type' => 'object', + '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' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Agent', + 'description' => '- Before deletion, we recommend that you confirm the agent account name and instance ID to be deleted. For guidance on how to obtain them, see the description of [Request Parameters](#api-detail-35).'."\n" + .'- If an agent is accidentally deleted, you can invoke the [CreateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createagent) API to recreate the agent.'."\n" + ."\n" + .'> If an account is re-added after deletion, the agent ID remains unchanged.'."\n" + ."\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', + 'changeSet' => [ + ['createdAt' => '2025-05-14T01:41:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'aiccs:DeleteAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DeleteAiOutboundTask' => [ + 'summary' => 'Deletes an Intelligent Outbound Calling job by instance ID and job ID. After deletion, the job will no longer appear in the outbound calling job list.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'DepIds', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组分组id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据技能组分组id分组显示', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can call the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or call the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'message', - 'title' => '错误描述', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总共记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '每页的数量', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => '数据', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'The request status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'result', + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete an Intelligent Outbound Calling Job', + 'description' => '><notice>Deletion is a sensitive operation. Proceed with caution.></notice>'."\n" + ."\n" + .'- Before deletion, we recommend that you confirm the job ID and related information. You can call the [GetAiOutboundTaskList](~~2718026~~) API to view the outbound calling job list and verify the task name, description, and corresponding job ID.'."\n" + .'- If you need to recreate an Intelligent Outbound Calling job, you can call the [CreateAiOutboundTask](~~312260~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 20 times/second.'."\n" + .'- API invocation frequency: 20 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAiOutboundTask'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"message\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":905,\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"department_id\\\\\\":-1,\\\\\\"department_name\\\\\\":-1,\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":20210329,\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetDepartmentalLatitudeAgentStatusResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <0>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <dateid>20210329</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n </0>\\n <1>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <ninservicenow>0</ninservicenow>\\n <dateid>20210401</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n </1>\\n </Rows>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetDepartmentalLatitudeAgentStatusResponse>","errorExample":""}]', - 'title' => 'GetDepartmentalLatitudeAgentStatus', + 'ramActions' => [], ], - 'GetSkillGroupLatitudeState' => [ - 'summary' => '技能组纬度状态量', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteDepartment' => [ + 'summary' => 'Deletes department information based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5210,130 +3309,205 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'The AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'StartDate', + 'name' => 'DepartmentId', 'in' => 'query', + 'schema' => ['description' => 'The department ID. '."\n" + ."\n" + .'You can call the [GetAllDepartment](~~2717975~~) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '12****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'seccessful', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + .'- **true**: Succeeded'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'The specified department does not exist.', 'errorCode' => 'Department.NotFound', 'description' => ''], + ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"seccessful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Department Information', + 'description' => '- Deletion is a sensitive operation. Proceed with caution.'."\n" + ."\n" + .'- Before invoking this API, we recommend that you confirm the AICCS instance ID and department ID. For guidance on how to obtain them, see the instructions in [Request Parameters](#api-detail-35).'."\n" + .'- If you accidentally delete department information, you can call the [CreateDepartment](~~2717974~~) API to recreate it.'."\n" + ."\n\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: 100 times/second.'."\n" + .'- API invocation frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDepartment'], + ], + ], + 'ramActions' => [], + ], + 'DeleteHotlineNumber' => [ + 'summary' => 'Invoke the DeleteHotlineNumber API to delete a configured hotline number.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CurrentPage', - 'in' => 'query', + 'name' => 'HotlineNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The hotline number.', 'example' => '05710000****', 'pattern' => '^\\d+$', 'required' => true, 'title' => '', 'type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'title' => '', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'The status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete a configured hotline number', + 'changeSet' => [ + ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHotlineNumber'], + ], + ], + 'ramActions' => [], + ], + 'DeleteOutboundTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DepIds', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'OutboundTaskId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'simple', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'required' => false, - 'title' => '技能组id列表', - 'type' => 'array', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DeleteOuterAccount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExistDepartmentGrouping', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'OuterAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'External Account ID.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistSkillGroupGrouping', + 'name' => 'OuterAccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Type of the external account.', 'docRequired' => true, 'example' => 'aliyun', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -5341,288 +3515,206 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总共记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '每页的数量', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + .'- **true**: Succeeded'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210329\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0,\\\\\\"maximumqueuingtime\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupLatitudeStateResponse>\\n<code>200</code>\\n<data>\\n <pageNum>1</pageNum>\\n <pageSize>2000</pageSize>\\n <rows>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <groupname>-1</groupname>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <dateid>20210329</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <groupid>-1</groupid>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n <maximumqueuingtime>-1</maximumqueuingtime>\\n </rows>\\n <rows>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <groupname>-1</groupname>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <dateid>20210330</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <groupid>-1</groupid>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n <maximumqueuingtime>-1</maximumqueuingtime>\\n </rows>\\n <rows>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <groupname>-1</groupname>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <ninservicenow>0</ninservicenow>\\n <dateid>20210401</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <groupid>-1</groupid>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n <ninqueuenow>0</ninqueuenow>\\n <maximumqueuingtime>0</maximumqueuingtime>\\n </rows>\\n <rows>\\n <tenantid>905</tenantid>\\n <nresttypenow>0</nresttypenow>\\n <tenantname>非单元测试化BU</tenantname>\\n <nresttype1now>0</nresttype1now>\\n <groupname>-1</groupname>\\n <departmentid>-1</departmentid>\\n <departmentname>-1</departmentname>\\n <nresttype98now>0</nresttype98now>\\n <nonlinenow>0</nonlinenow>\\n <ninservicenow>0</ninservicenow>\\n <dateid>20210331</dateid>\\n <nresttype3now>0</nresttype3now>\\n <nresttype5now>0</nresttype5now>\\n <nbusynow>0</nbusynow>\\n <nresttype2now>0</nresttype2now>\\n <groupid>-1</groupid>\\n <nidlenow>0</nidlenow>\\n <nresttype4now>0</nresttype4now>\\n <nacknow>0</nacknow>\\n <nresttype99now>0</nresttype99now>\\n <ninqueuenow>0</ninqueuenow>\\n <maximumqueuingtime>0</maximumqueuingtime>\\n </rows>\\n <totalNum>4</totalNum>\\n</data>\\n<httpStatusCode>200</httpStatusCode>\\n<message>successful</message>\\n<requestId>197C2792-E080-48BD-BDC7-F4A02852052E</requestId>\\n<success>true</success>\\n</GetSkillGroupLatitudeStateResponse>","errorExample":""}]', - 'title' => 'GetSkillGroupLatitudeState', - ], - 'GetAgentBasisStatus' => [ - 'summary' => '坐席纬度基础状态量', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete External Account', + 'summary' => 'Invoke DeleteOuterAccount to delete an external account by its external Account ID.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteQualityProject' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DeleteQualityRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'Id', 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'DeleteSkillGroup' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AgentIds', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'OuterGroupType', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '["2256****","2257****"]', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '坐席id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'External skill group type. Valid enumeration values are: 1: Hotline, 2: Online, 4: Ticket', 'example' => '2', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DepIds', + 'name' => 'OuterGroupId', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '["6083****","6084****"]', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'External skill group ID', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of an error', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Data', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"73****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"测试\\\\\\",\\\\\\"recordgmtmodified\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"7320372021****\\\\\\",\\\\\\"statusstarttime\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"recordgmtcreate\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"94****\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"测试技能组\\\\\\",\\\\\\"lstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"triggerreason\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_status\\\\\\":\\\\\\"D\\\\\\",\\\\\\"assignstatus\\\\\\":\\\\\\"1\\\\\\",\\\\\\"servicerreal_name\\\\\\":\\\\\\"xx\\\\\\",\\\\\\"servicerstatusname\\\\\\":\\\\\\"签出\\\\\\",\\\\\\"fstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"servicer_name\\\\\\":\\\\\\"xx\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentBasisStatusResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <tenantid>905</tenantid>\\n <servicerid>732037</servicerid>\\n <tenantname>测试</tenantname>\\n <recordgmtmodified>2021-04-01 11:36:50</recordgmtmodified>\\n <pkid>73203720210401</pkid>\\n <statusstarttime>2021-04-01 11:36:50</statusstarttime>\\n <recordgmtcreate>2021-04-01 10:06:24</recordgmtcreate>\\n <departmentid>945044</departmentid>\\n <departmentname>测试技能组</departmentname>\\n <lstlogintime>2021-04-01 10:06:24</lstlogintime>\\n <dateid>20210401</dateid>\\n <triggerreason>3</triggerreason>\\n <servicerstatus>D</servicerstatus>\\n <assignstatus>1</assignstatus>\\n <servicerrealname>xx</servicerrealname>\\n <servicerstatusname>签出</servicerstatusname>\\n <fstlogintime>2021-04-01 10:06:24</fstlogintime>\\n <servicername>xx</servicername>\\n </Rows>\\n <Rows>\\n <tenantid>905</tenantid>\\n <servicerid>674154</servicerid>\\n <tenantname>测试</tenantname>\\n <recordgmtmodified>2021-04-01 10:02:44</recordgmtmodified>\\n <pkid>67415420210401</pkid>\\n <statusstarttime>2021-04-01 10:02:44</statusstarttime>\\n <recordgmtcreate>2021-04-01 09:41:08</recordgmtcreate>\\n <departmentid>10</departmentid>\\n <departmentname>default</departmentname>\\n <lstlogintime>2021-04-01 09:41:08</lstlogintime>\\n <dateid>20210401</dateid>\\n <triggerreason>3</triggerreason>\\n <servicerstatus>D</servicerstatus>\\n <assignstatus>1</assignstatus>\\n <servicerrealname>xx</servicerrealname>\\n <servicerstatusname>签出</servicerstatusname>\\n <fstlogintime>2021-04-01 09:24:39</fstlogintime>\\n <servicername>xx</servicername>\\n </Rows>\\n </Data>\\n</GetAgentBasisStatusResponse>","errorExample":""}]', - 'title' => 'GetAgentBasisStatus', - ], - 'GetAgentStatistics' => [ - 'summary' => '坐席纬度统计量', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Skill Group', + 'summary' => 'Deletes an external skill group based on the skill group ID and skill group channel type.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DescribeRecordData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5634,137 +3726,36 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '15566', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], - ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'AgentIds', + 'name' => 'ProdCode', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '坐席id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ - 'name' => 'DepIds', + 'name' => 'AccountType', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Account type.', 'example' => 'BUC_TYPE', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TimeLatitudeType', + 'name' => 'AccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'minute', - 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', - ], + 'schema' => ['description' => 'AccountId.', 'example' => '2235****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Session ID.', 'example' => '1004849****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistAgentGrouping', + 'name' => 'SecLevel', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据坐席分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Recording desensitization level. Valid values: **1–4**.', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ @@ -5772,968 +3763,794 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '{"n_resttype_1":15,"t_outcall_speak":829747,"average_incoming_time":"8451.29","n_resttype_3":0,"minute_id":"-1","n_conference_speak":0,"n_resttype_2":0,"n_resttype_5":0,"n_resttype_4":0,"n_resttype_7":0,"n_resttype_6":0,"n_resttype_9":0,"n_resttype_8":0,"n_outcall_dial":25,"total_break_time":"58555","n_internal_speak":0,"n_send_step_transfer":7,"n_consulted_internal_speak":0}', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Acid' => ['description' => 'Session ID.', 'example' => '1004849****', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Message' => ['description' => 'Status code description.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'OssLink' => ['description' => 'Recording file link.', 'example' => 'https://****', 'type' => 'string', 'title' => ''], + 'AgentId' => ['description' => 'Agent ID.', 'example' => '1212****', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Acid\\": \\"1004849****\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"OssLink\\": \\"https://****\\",\\n \\"AgentId\\": \\"1212****\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Call Records', + 'summary' => 'Invoke the DescribeRecordData API to retrieve call information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"n_resttype_1\\\\\\":15,\\\\\\"t_outcall_speak\\\\\\":829747,\\\\\\"average_incoming_time\\\\\\":\\\\\\"8451.29\\\\\\",\\\\\\"n_resttype_3\\\\\\":0,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_conference_speak\\\\\\":0,\\\\\\"n_resttype_2\\\\\\":0,\\\\\\"n_resttype_5\\\\\\":0,\\\\\\"n_resttype_4\\\\\\":0,\\\\\\"n_resttype_7\\\\\\":0,\\\\\\"n_resttype_6\\\\\\":0,\\\\\\"n_resttype_9\\\\\\":0,\\\\\\"n_resttype_8\\\\\\":0,\\\\\\"n_outcall_dial\\\\\\":25,\\\\\\"total_break_time\\\\\\":\\\\\\"58555\\\\\\",\\\\\\"n_internal_speak\\\\\\":0,\\\\\\"n_send_step_transfer\\\\\\":7,\\\\\\"n_consulted_internal_speak\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentStatisticsResponse>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <n_resttype_1>15</n_resttype_1>\\n <t_outcall_speak>829747</t_outcall_speak>\\n <average_incoming_time>8451.29</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>25</n_outcall_dial>\\n <total_break_time>58555</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>7</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>149082</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>7</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>0</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>16080</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>42475</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>19</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>3354042</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210401</date_id>\\n <t_login>24351698</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>1</n_hold>\\n <average_post_processing_time>119787.21</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>14.02%</agent_utilization>\\n <n_resttype_99>33</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>59159</t_incall_speak>\\n <n_incall_speak>7</n_incall_speak>\\n <t_idle>13479337</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>0</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>32143</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>10272</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>28</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>37</n_resttype_1>\\n <t_outcall_speak>1488093</t_outcall_speak>\\n <average_incoming_time>33735.46</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>55</n_outcall_dial>\\n <total_break_time>12864720.00</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>18</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>239446</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>19</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>12335654</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>31206</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>497860</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>44</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>7312000</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210331</date_id>\\n <t_login>89671620</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>19</n_hold>\\n <average_post_processing_time>110787.88</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>8.64%</agent_utilization>\\n <n_resttype_99>78</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>438561</t_incall_speak>\\n <n_incall_speak>13</n_incall_speak>\\n <t_idle>35241392</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>1</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>108450</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>155824</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>66</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>2</n_resttype_1>\\n <t_outcall_speak>522649</t_outcall_speak>\\n <average_incoming_time>18256.25</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>16</n_outcall_dial>\\n <total_break_time>9691903.00</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>6</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>58753</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>8</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>9651198</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>0</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>40705</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>15</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>6827000</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210330</date_id>\\n <t_login>51739230</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>15</n_hold>\\n <average_post_processing_time>341350</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>13.34%</agent_utilization>\\n <n_resttype_99>13</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>73025</t_incall_speak>\\n <n_incall_speak>4</n_incall_speak>\\n <t_idle>14771327</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>2</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>111221</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>244633</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>20</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>1</n_resttype_1>\\n <t_outcall_speak>1820512</t_outcall_speak>\\n <average_incoming_time>45884</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>33</n_outcall_dial>\\n <total_break_time>1519362</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>0</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>146820</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>4</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>1517714</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>1000</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>648</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>30</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>1865504</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210329</date_id>\\n <t_login>32107726</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>6</n_hold>\\n <average_post_processing_time>60177.55</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>5.95%</agent_utilization>\\n <n_resttype_99>21</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>45884</t_incall_speak>\\n <n_incall_speak>1</n_incall_speak>\\n <t_idle>17206386</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>1</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>69951</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>222646</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>31</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>1</n_resttype_1>\\n <t_outcall_speak>0</t_outcall_speak>\\n <average_incoming_time>0</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>0</n_outcall_dial>\\n <total_break_time>1104</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>0</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>0</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>0</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>0</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>0</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>1104</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>0</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>0</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210328</date_id>\\n <t_login>38104</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>0</n_hold>\\n <average_post_processing_time>0</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>0.00%</agent_utilization>\\n <n_resttype_99>1</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>0</t_incall_speak>\\n <n_incall_speak>0</n_incall_speak>\\n <t_idle>22000</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>0</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>0</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>0</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>0</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>1</n_resttype_1>\\n <t_outcall_speak>2631</t_outcall_speak>\\n <average_incoming_time>5190</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>2</n_outcall_dial>\\n <total_break_time>12264</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>0</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <t_consulted_internal_ring>0</t_consulted_internal_ring>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <t_outcall_dial>58169</t_outcall_dial>\\n <t_resttype_14>0</t_resttype_14>\\n <servicer_id>-1</servicer_id>\\n <t_resttype_13>0</t_resttype_13>\\n <n_incall_ring>2</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <t_resttype_15>0</t_resttype_15>\\n <t_resttype_9>0</t_resttype_9>\\n <t_resttype_8>0</t_resttype_8>\\n <t_resttype_7>0</t_resttype_7>\\n <t_resttype_6>0</t_resttype_6>\\n <t_resttype_98>9831</t_resttype_98>\\n <t_resttype_10>0</t_resttype_10>\\n <t_resttype_12>0</t_resttype_12>\\n <t_resttype_99>1000</t_resttype_99>\\n <t_resttype_11>0</t_resttype_11>\\n <t_resttype_1>1433</t_resttype_1>\\n <t_internal_dial>0</t_internal_dial>\\n <t_resttype_5>0</t_resttype_5>\\n <t_resttype_4>0</t_resttype_4>\\n <t_resttype_3>0</t_resttype_3>\\n <t_resttype_2>0</t_resttype_2>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>1</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <t_acw>18000</t_acw>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210326</date_id>\\n <t_login>12557584</t_login>\\n <t_internal_speak>0</t_internal_speak>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <t_consulted_internal_speak>0</t_consulted_internal_speak>\\n <n_hold>1</n_hold>\\n <average_post_processing_time>6000</average_post_processing_time>\\n <t_consult_external_speak>0</t_consult_external_speak>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <t_incall_acw_end>0</t_incall_acw_end>\\n <n_resttype_14>0</n_resttype_14>\\n <t_conference_speak>0</t_conference_speak>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>0.18%</agent_utilization>\\n <n_resttype_99>2</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <t_incall_speak>5190</t_incall_speak>\\n <n_incall_speak>1</n_incall_speak>\\n <t_idle>445320</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>1</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <t_consult_internal_speak>0</t_consult_internal_speak>\\n <t_incall_ring>32202</t_incall_ring>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <t_outcall_acw_end>0</t_outcall_acw_end>\\n <t_hold>21478</t_hold>\\n <t_internal_ring>0</t_internal_ring>\\n <t_held>0</t_held>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>3</n_acw>\\n </Rows>\\n <Rows>\\n <n_resttype_1>0</n_resttype_1>\\n <average_incoming_time>-1</average_incoming_time>\\n <n_resttype_3>0</n_resttype_3>\\n <minute_id>-1</minute_id>\\n <n_conference_speak>0</n_conference_speak>\\n <n_resttype_2>0</n_resttype_2>\\n <n_resttype_5>0</n_resttype_5>\\n <n_resttype_4>0</n_resttype_4>\\n <n_resttype_7>0</n_resttype_7>\\n <n_resttype_6>0</n_resttype_6>\\n <n_resttype_9>0</n_resttype_9>\\n <n_resttype_8>0</n_resttype_8>\\n <n_outcall_dial>0</n_outcall_dial>\\n <total_break_time>0</total_break_time>\\n <n_internal_speak>0</n_internal_speak>\\n <n_send_step_transfer>0</n_send_step_transfer>\\n <n_consulted_internal_speak>0</n_consulted_internal_speak>\\n <n_internal_ring>0</n_internal_ring>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_send_monitor_error>0</n_send_monitor_error>\\n <servicer_id>-1</servicer_id>\\n <n_incall_ring>0</n_incall_ring>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <servicer_name>-1</servicer_name>\\n <n_outcall_speak>0</n_outcall_speak>\\n <n_send_finish_transfer>0</n_send_finish_transfer>\\n <tenant_id>905</tenant_id>\\n <n_held>0</n_held>\\n <n_consult_internal_speak>0</n_consult_internal_speak>\\n <date_id>20210325</date_id>\\n <t_login>2098898</t_login>\\n <hour_id>-1</hour_id>\\n <n_internal_dial>0</n_internal_dial>\\n <n_consult_internal_dial>0</n_consult_internal_dial>\\n <n_hold>0</n_hold>\\n <average_post_processing_time>-1</average_post_processing_time>\\n <n_consulted_internal_ring>0</n_consulted_internal_ring>\\n <n_resttype_15>0</n_resttype_15>\\n <n_resttype_14>0</n_resttype_14>\\n <n_resttype_13>0</n_resttype_13>\\n <n_resttype_12>0</n_resttype_12>\\n <agent_utilization>-1</agent_utilization>\\n <n_resttype_99>0</n_resttype_99>\\n <n_resttype_11>0</n_resttype_11>\\n <n_incall_speak>0</n_incall_speak>\\n <t_idle>2098898</t_idle>\\n <department_id>-1</department_id>\\n <n_consult_external_dial>0</n_consult_external_dial>\\n <n_outcall_acw_end>0</n_outcall_acw_end>\\n <department_name>-1</department_name>\\n <n_consult_external_speak>0</n_consult_external_speak>\\n <n_resttype_98>0</n_resttype_98>\\n <n_resttype_10>0</n_resttype_10>\\n <n_incall_acw_end>0</n_incall_acw_end>\\n <n_send_conference>0</n_send_conference>\\n <n_acw>0</n_acw>\\n </Rows>\\n</Data>\\n</GetAgentStatisticsResponse>","errorExample":""}]', - 'title' => 'GetAgentStatistics', - ], - 'GetOnlineServiceVolume' => [ - 'summary' => '在线服务总量', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:DescribeRecordData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'EditQualityProject' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CheckFreqType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'ScopeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AgentIds', + 'name' => 'TimeRangeStart', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '坐席id列表', - 'type' => 'array', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DepIds', + 'name' => 'TimeRangeEnd', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'AnalysisIds', 'in' => 'query', - 'style' => 'simple', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组id列表', 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TimeLatitudeType', + 'name' => 'DepList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'minute', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExistAgentGrouping', + 'name' => 'GroupList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'false', + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, - 'title' => '是否根据坐席分组', - 'type' => 'boolean', + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'ServicerList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'false', + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', + 'maxItems' => 3, + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExistSkillGroupGrouping', + 'name' => 'ChannelTouchType', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '{"tenant_id":"905","online_40s_transfer_ready_cnt":109,"minute_id":"-1","wait_time_len":1215,"pickup_rate":"63.09%","thirty_seconds_to_pickUp":"2560","date_id":"-1","online_over_out_cnt":0,"online_20s_transfer_ready_cnt":109,"thirty_seconds_response_rate":"63.09%","abandonment_rate":"63.09%","service_time_len":68378,"service_pickup":"2560","hour_id":"-1","online_10s_transfer_ready_cnt":109}', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Version' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"online_40s_transfer_ready_cnt\\\\\\":109,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"wait_time_len\\\\\\":1215,\\\\\\"pickup_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"thirty_seconds_to_pickUp\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_over_out_cnt\\\\\\":0,\\\\\\"online_20s_transfer_ready_cnt\\\\\\":109,\\\\\\"thirty_seconds_response_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"abandonment_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"service_time_len\\\\\\":68378,\\\\\\"service_pickup\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"hour_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_10s_transfer_ready_cnt\\\\\\":109}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOnlineServiceVolumeResponse>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <0>\\n <tenant_id>905</tenant_id>\\n <online_40s_transfer_ready_cnt>109</online_40s_transfer_ready_cnt>\\n <minute_id>-1</minute_id>\\n <wait_time_len>1215</wait_time_len>\\n <pickup_rate>63.09%</pickup_rate>\\n <thirty_seconds_to_pickUp>2560</thirty_seconds_to_pickUp>\\n <date_id>-1</date_id>\\n <online_over_out_cnt>0</online_over_out_cnt>\\n <online_20s_transfer_ready_cnt>109</online_20s_transfer_ready_cnt>\\n <thirty_seconds_response_rate>63.09%</thirty_seconds_response_rate>\\n <abandonment_rate>63.09%</abandonment_rate>\\n <service_time_len>68378</service_time_len>\\n <service_pickup>2560</service_pickup>\\n <hour_id>-1</hour_id>\\n <online_10s_transfer_ready_cnt>109</online_10s_transfer_ready_cnt>\\n <online_direct_request_cnt>3843</online_direct_request_cnt>\\n <online_60s_transfer_ready_cnt>109</online_60s_transfer_ready_cnt>\\n <service_request_volume>4058</service_request_volume>\\n <servicer_real_name>--</servicer_real_name>\\n <online_transfer_giveup_cnt>88</online_transfer_giveup_cnt>\\n <online_direct_ready_cnt>2451</online_direct_ready_cnt>\\n <online_unsat_cnt>0</online_unsat_cnt>\\n <att>26</att>\\n <servicer_id>-1</servicer_id>\\n <online_20s_direct_ready_cnt>2451</online_20s_direct_ready_cnt>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <online_30s_direct_ready_cnt>2451</online_30s_direct_ready_cnt>\\n <online_10s_direct_ready_cnt>2450</online_10s_direct_ready_cnt>\\n <group_name>-1</group_name>\\n <department_id>-1</department_id>\\n <department_name>-1</department_name>\\n <online_30s_transfer_ready_cnt>109</online_30s_transfer_ready_cnt>\\n <satisfaction>100.00%</satisfaction>\\n <online_transfer_ready_cnt>109</online_transfer_ready_cnt>\\n <online_sat_cnt>1</online_sat_cnt>\\n <online_direct_giveup_cnt>1392</online_direct_giveup_cnt>\\n <group_id>-1</group_id>\\n <online_transfer_request_cnt>215</online_transfer_request_cnt>\\n <online_normal_cnt>0</online_normal_cnt>\\n <servicer_name>--</servicer_name>\\n <online_60s_direct_ready_cnt>2451</online_60s_direct_ready_cnt>\\n <online_40s_direct_ready_cnt>2451</online_40s_direct_ready_cnt>\\n <online_over_in_cnt>0</online_over_in_cnt>\\n </0>\\n </Rows>\\n</Data>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n</GetOnlineServiceVolumeResponse>","errorExample":""}]', - 'title' => 'GetOnlineServiceVolume', - ], - 'GetSeatInformation' => [ - 'summary' => '部门纬度坐席信息数据', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Version\\": 0,\\n \\"ProjectId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'EditQualityRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'startDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'endDate', - 'in' => 'query', + 'name' => 'RuleTag', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'MatchType', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'QualityRuleId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'KeyWords', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'required' => true, + 'maxItems' => 3, 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'pageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + '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' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'EditQualityRuleTag' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'currentPage', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'depIds', + 'name' => 'AnalysisTypes', 'in' => 'query', - 'style' => 'simple', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', + 'type' => 'array', 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], - ], - [ - 'name' => 'existDepartmentGrouping', - 'in' => 'query', - 'schema' => [ + 'required' => true, + 'maxItems' => 100, 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rowr' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rowr\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSeatInformationResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rowr>{\\"tenant_id\\": \\"905\\", \\"tenant_name\\": \\"非单元测试化BU\\", \\"department_id\\": \\"-1\\", \\"svc_avai_capacity\\": 7, \\"svc_current_capacity\\": 0, \\"department_name\\": \\"-1\\", \\"svc_online_cnt\\": 3, \\"svc_ask_offline_servicer_num\\": 0, \\"date_id\\": \\"20210401\\", \\"svc_max_capacity\\": 7, \\"svc_rest_cnt\\": 0, \\"current_speci_ability_num\\": 0, \\"servicer_rest_cnt\\": 122, \\"max_speci_ability_num\\": 3, \\"svc_offline_cnt\\": 0, \\"svc_no_client_cnt\\": 3, \\"svc_ask_rest_servicer_num\\": 0}</Rowr>\\n </Data>\\n</GetSeatInformationResponse>","errorExample":""}]', - ], - 'GetSkillGroupServiceCapability' => [ - 'summary' => '技能组纬度服务能力', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'EncryptPhoneNum' => [ + 'summary' => 'Invoke EncryptPhoneNum to encrypt the User\'s Phone number.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'StartDate', + 'name' => 'PhoneNum', 'in' => 'query', + 'schema' => ['description' => 'The plaintext phone number.', 'example' => '130****0000', 'required' => true, 'title' => '', 'type' => 'string'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], + 'Data' => ['description' => 'The ciphertext after encryption.', 'example' => '20nJ****/9Fl/kxx/***7', 'title' => '', 'type' => 'string'], + 'Code' => ['description' => 'The status code. A return value of 200 indicates that the Request Succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API Call Succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Encrypt the User\'s Phone number', + 'changeSet' => [ + ['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPhoneNum'], + ], + ], + 'ramActions' => [], + ], + 'FetchCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'AK' => [], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request, used for idempotency validation; can be generated using UUID', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组id列表', - 'type' => 'array', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name (agent logon name)', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistDepartmentGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistSkillGroupGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'HoldConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The holdConnId from WebSocket after an inbound call (only provided during two-step transfer)', 'docRequired' => true, 'example' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int64', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of a fault', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\n \\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\",\\\\n \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\",\\\\n \\\\\\"group_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_online_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0,\\\\n \\\\\\"date_id\\\\\\": \\\\\\"20210326\\\\\\",\\\\n \\\\\\"group_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_rest_cnt\\\\\\": 0,\\\\n \\\\\\"servicer_rest_cnt\\\\\\": 234,\\\\n \\\\\\"svc_offline_cnt\\\\\\": 0,\\\\n \\\\\\"svc_no_client_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupServiceCapabilityResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>{\\n \\"tenant_id\\": \\"905\\",\\n \\"tenant_name\\": \\"非单元测试化BU\\",\\n \\"group_name\\": \\"-1\\",\\n \\"department_id\\": \\"-1\\",\\n \\"department_name\\": \\"-1\\",\\n \\"svc_online_cnt\\": 0,\\n \\"svc_ask_offline_servicer_num\\": 0,\\n \\"date_id\\": \\"20210326\\",\\n \\"group_id\\": \\"-1\\",\\n \\"svc_rest_cnt\\": 0,\\n \\"servicer_rest_cnt\\": 234,\\n \\"svc_offline_cnt\\": 0,\\n \\"svc_no_client_cnt\\": 0,\\n \\"svc_ask_rest_servicer_num\\": 0\\n}</Rows>\\n </Data>\\n</GetSkillGroupServiceCapabilityResponse>","errorExample":""}]', - ], - 'GetSkillGroupAgentStatusDetails' => [ - 'summary' => '技能组坐席状态详情', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Retrieve or recover a call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'FinishHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'StartDate', - 'in' => 'query', + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '1614824872', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'End Hotline Service', + 'summary' => 'End the hotline service by instance ID and agent account name.', + 'description' => '### Queries per second (QPS) limit'."\n" + .'- Per-user API call frequency: No rate limiting.'."\n" + .'- API frequency: 100 calls per second.'."\n" + ."\n" + .'> If the total number of calls from multiple users exceeds the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GenerateWebSocketSign' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1614824972', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'AK' => [], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'MessageBox message channel signature code.', 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Generate MessageBox Channel Signature', + 'summary' => 'Generate a message channel access signature based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and agent account name. ', + 'description' => '- You can invoke this API to generate a message channel access signature. The **Data** field in the response contains the MessageBox message channel signature code.'."\n" + ."\n" + .'- Before invoking the API, we recommend that you confirm your AICCS instance ID. For instructions on how to obtain it, see the description of [Request Parameters](#api-detail-35).'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API-wide frequency: 100 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetAgent' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupIds', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ClientToken', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExistSkillGroupGrouping', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Agent data.', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int64', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int64', - 'title' => '每页的数量', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', + 'Status' => ['description' => 'Agent status. Valid values:'."\n" + ."\n" + .'- **0**: Normal'."\n" + .'- **1**: Freeze'."\n" + .'- **2**: Delete'."\n" + ."\n" + .'> Only agents with a Normal status can perform Business Activities.', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID to which the agent belongs, corresponding to the instance ID in the request parameters.', 'example' => '0', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'GroupList' => [ + 'description' => 'Skill group information to which the agent belongs.', + 'items' => [ + 'description' => 'Skill group information.', + 'properties' => [ + 'Description' => ['description' => 'Skill group description.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'DisplayName' => ['description' => 'Display name of the skill group.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'SkillGroupId' => ['description' => 'Skill group ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelType' => ['description' => 'Skill group channel type.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Name' => ['description' => 'Skill group name.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', ], + 'DisplayName' => ['description' => 'Agent display name shown externally.', 'example' => 'XX测试', 'type' => 'string', 'title' => ''], + 'AgentId' => ['description' => 'Agent ID.', 'example' => '222222', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'AccountName' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. Unique within the instance.', 'example' => 'username@example.com', 'type' => 'string', 'title' => ''], ], - 'title' => 'data', 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'string', - ], + 'Code' => ['description' => 'Status code. A return value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupAgentStatusDetailsResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>successful</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>{\\"tenant_id\\": \\"905\\", \\"tenant_name\\": \\"非单元测试化BU\\", \\"department_id\\": \\"-1\\", \\"svc_avai_capacity\\": 7, \\"svc_current_capacity\\": 0, \\"department_name\\": \\"-1\\", \\"svc_online_cnt\\": 3, \\"svc_ask_offline_servicer_num\\": 0, \\"date_id\\": \\"20210401\\", \\"svc_max_capacity\\": 7, \\"svc_rest_cnt\\": 0, \\"current_speci_ability_num\\": 0, \\"servicer_rest_cnt\\": 122, \\"max_speci_ability_num\\": 3, \\"svc_offline_cnt\\": 0, \\"svc_no_client_cnt\\": 3, \\"svc_ask_rest_servicer_num\\": 0}</Rows>\\n </Data>\\n</GetSkillGroupAgentStatusDetailsResponse>","errorExample":""}]', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"GroupList\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 1,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DisplayName\\": \\"XX测试\\",\\n \\"AgentId\\": 222222,\\n \\"AccountName\\": \\"username@example.com\\"\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain agent information', + 'summary' => 'Query agent information in the Cloud Customer Service System by instance ID and agent account name, such as agent ID.', + 'description' => '- Before invoking this API, confirm the AICCS instance information and the agent account name. For guidance on how to obtain these details, refer to the instructions in [Request Parameters](#api-detail-35).'."\n" + .'- Deleted agents can also be queried. Check the **Status** parameter in the response. If its value is 2, it indicates that the agent has been deleted.'."\n" + ."\n" + .'### queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No Rate Limiting.'."\n" + .'- API frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetOnlineSeatInformation' => [ - 'summary' => '在线坐席信息', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentBasisStatus' => [ + 'summary' => 'Obtain the agent-level status metrics under hotline monitoring. Supports queries by instance, time range, agent, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6741,89 +4558,47 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the **Instance Management** section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The UNIX timestamp of the start date. Unit: milliseconds. ', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'End Datetime UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**. ', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**. ', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of agent IDs. ', + 'items' => ['description' => 'Agent ID.'."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response parameters to obtain the agent ID.', 'example' => '["2256****","2257****"]', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '坐席id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ @@ -6831,17 +4606,14 @@ 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of department IDs. ', + 'items' => ['description' => 'The department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** field in the response to obtain the department ID. ', 'example' => '["6083****","6084****"]', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '部门id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], ], @@ -6850,85 +4622,72 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'OK', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Data list. ', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'The information is a JSON string of the List<Map> type. ', 'example' => '{"tenant_id":"905","servicer_id":"73****","tenant_name":"测试","recordgmtmodified":"2021-04-01 11:36:50","pk_id":"7320372021****","statusstarttime":"2021-04-01 11:36:50","recordgmtcreate":"2021-04-01 10:06:24","department_id":"94****","department_name":"测试技能组","lstlogintime":"2021-04-01 10:06:24","date_id":"20210401","triggerreason":"3","servicer_status":"D","assignstatus":"1","servicerreal_name":"xx","servicerstatusname":"签出","fstlogintime":"2021-04-01 10:06:24","servicer_name":"xx"}', 'title' => '', 'type' => 'string'], ], 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Code' => ['description' => 'The status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"max_service_num\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"36****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"record_gmt_modified\\\\\\":\\\\\\"2021-04-01 23:20:03\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"3690012021****\\\\\\",\\\\\\"record_gmt_create\\\\\\":\\\\\\"2021-04-01 23:19:55\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"10****\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetOnlineSeatInformationResponse>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <0>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369001</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:03</record_gmt_modified>\\n <pk_id>36900120210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107621101</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试003</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:32</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试003</servicer_name>\\n <servicer_rest_cnt>48</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </0>\\n <1>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369003</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:36</record_gmt_modified>\\n <pk_id>36900320210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107633801</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:35</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试005</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试005</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </1>\\n <2>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>353026</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:01</record_gmt_modified>\\n <pk_id>35302620210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:56</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107421301</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试002</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:54</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试002</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </2>\\n <3>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369009</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 16:24:57</record_gmt_modified>\\n <pk_id>36900920210401</pk_id>\\n <record_gmt_create>2021-04-01 16:21:01</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1080001</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 16:21:03</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试011</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 02:08:15</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试011</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </3>\\n <4>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>353026</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:36</record_gmt_modified>\\n <pk_id>35302620210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:31</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342801</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:36</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试002</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:45</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试002</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </4>\\n <5>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>223001</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 15:43:10</record_gmt_modified>\\n <pk_id>22300120210401</pk_id>\\n <record_gmt_create>2021-04-01 14:19:49</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1080025</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 15:23:04</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>李步挺</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 09:57:48</fst_login_time>\\n <servicer_name>李步挺</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </5>\\n <6>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369008</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:00</record_gmt_modified>\\n <pk_id>36900820210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107621001</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>0</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试010</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:12</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试010</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </6>\\n <7>\\n <tenant_id>905</tenant_id>\\n <max_service_num>1</max_service_num>\\n <servicer_id>369002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:22:05</record_gmt_modified>\\n <pk_id>36900220210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342601</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:22:00</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试004</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试004</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </7>\\n <8>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>386018</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:39</record_gmt_modified>\\n <pk_id>38601820210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107717801</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:39</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>17000000098</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>17000000098</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </8>\\n <9>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>83001</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 16:42:07</record_gmt_modified>\\n <pk_id>8300120210402</pk_id>\\n <record_gmt_create>2021-04-02 16:41:09</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1086003</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 16:42:07</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>英如</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 16:41:09</fst_login_time>\\n <servicer_name>英如</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </9>\\n <10>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>288074</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 11:30:19</record_gmt_modified>\\n <pk_id>28807420210401</pk_id>\\n <record_gmt_create>2021-04-01 10:56:48</record_gmt_create>\\n <department_id>862009</department_id>\\n <workset_user_id>-288074</workset_user_id>\\n <department_name>冯相</department_name>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>1</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>冯相</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <servicer_name>言恒</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 00:00:00</workset_end_date>\\n </10>\\n <11>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>317004</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:04</record_gmt_modified>\\n <pk_id>31700420210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:54</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107331201</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:04</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试001</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:11</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试001</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </11>\\n <12>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>759020</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 19:18:51</record_gmt_modified>\\n <pk_id>75902020210401</pk_id>\\n <record_gmt_create>2021-04-01 19:12:51</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>106600248</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 19:12:51</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>13291408908</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 10:10:43</fst_login_time>\\n <servicer_name>13291408908</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </12>\\n <13>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>317004</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:38</record_gmt_modified>\\n <pk_id>31700420210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:36</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107431601</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:38</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试001</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:43</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试001</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </13>\\n <14>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369004</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:36</record_gmt_modified>\\n <pk_id>36900420210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107633701</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:35</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试006</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试006</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </14>\\n <15>\\n <tenant_id>905</tenant_id>\\n <max_service_num>5</max_service_num>\\n <servicer_id>110002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:19:56</record_gmt_modified>\\n <pk_id>11000220210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:54</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107620901</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:19:56</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>念茹</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:11</fst_login_time>\\n <servicer_name>念茹</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </15>\\n <16>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369003</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:00</record_gmt_modified>\\n <pk_id>36900320210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107421201</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试005</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:53</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试005</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </16>\\n <17>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369013</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:01</record_gmt_modified>\\n <pk_id>36901320210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107421001</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:01</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>1</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试015</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>在线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:22</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试015</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </17>\\n <18>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369004</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:00</record_gmt_modified>\\n <pk_id>36900420210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107519701</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>0</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试006</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:48</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试006</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </18>\\n <19>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369007</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:36</record_gmt_modified>\\n <pk_id>36900720210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342701</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:36</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试009</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试009</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </19>\\n <20>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>386018</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:04</record_gmt_modified>\\n <pk_id>38601820210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107331301</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:04</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>0</servicer_status>\\n <servicer_real_name>17000000098</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:23</fst_login_time>\\n <servicer_name>17000000098</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </20>\\n <21>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369009</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 10:28:45</record_gmt_modified>\\n <pk_id>36900920210402</pk_id>\\n <record_gmt_create>2021-04-02 10:25:15</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1085002</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 10:25:17</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试011</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 02:12:15</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试011</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </21>\\n <22>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>362137</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 00:32:10</record_gmt_modified>\\n <pk_id>36213720210401</pk_id>\\n <record_gmt_create>2021-04-01 00:24:51</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>106600229</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 00:32:09</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>15700089356</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:24:51</fst_login_time>\\n <servicer_name>15700089356</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </22>\\n <23>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>721093</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 18:42:13</record_gmt_modified>\\n <pk_id>72109320210401</pk_id>\\n <record_gmt_create>2021-04-01 18:20:38</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1083002</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 18:22:16</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>马珍4号</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 18:20:38</fst_login_time>\\n <servicer_name>马珍4号</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </23>\\n <24>\\n <tenant_id>905</tenant_id>\\n <max_service_num>2</max_service_num>\\n <servicer_id>219005</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 19:01:22</record_gmt_modified>\\n <pk_id>21900520210402</pk_id>\\n <record_gmt_create>2021-04-02 17:24:02</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1086002</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 17:24:02</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>云殊</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 15:59:02</fst_login_time>\\n <servicer_name>云殊</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </24>\\n <25>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>772041</servicer_id>\\n <record_gmt_modified>2021-04-02 11:05:59</record_gmt_modified>\\n <pk_id>77204120210402</pk_id>\\n <record_gmt_create>2021-04-02 10:57:17</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-772041</workset_user_id>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>1</current_service_num>\\n <servicer_status>D</servicer_status>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <servicer_name>易南</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-03 00:00:00</workset_end_date>\\n </25>\\n <26>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>195002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 10:42:27</record_gmt_modified>\\n <pk_id>19500220210401</pk_id>\\n <record_gmt_create>2021-04-01 10:25:45</record_gmt_create>\\n <department_id>83002</department_id>\\n <workset_user_id>107336201</workset_user_id>\\n <department_name>百富旅行</department_name>\\n <lst_login_time>2021-04-01 10:25:45</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>翰怀real</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 10:25:45</fst_login_time>\\n <servicer_name>翰怀show</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </26>\\n <27>\\n <tenant_id>905</tenant_id>\\n <max_service_num>2</max_service_num>\\n <servicer_id>219005</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 19:11:41</record_gmt_modified>\\n <pk_id>21900520210401</pk_id>\\n <record_gmt_create>2021-04-01 00:33:37</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>106600230</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 00:33:37</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>云殊</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:33:37</fst_login_time>\\n <servicer_name>云殊</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </27>\\n <28>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369007</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:00</record_gmt_modified>\\n <pk_id>36900720210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107621201</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:00</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>0</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试009</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:20:02</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试009</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </28>\\n <29>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>549011</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 15:06:17</record_gmt_modified>\\n <pk_id>54901120210401</pk_id>\\n <record_gmt_create>2021-04-01 14:55:04</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-549011</workset_user_id>\\n <department_name>default</department_name>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>0</servicer_status>\\n <servicer_real_name>18818262279</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <servicer_name>18818262279</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 00:00:00</workset_end_date>\\n </29>\\n <30>\\n <tenant_id>905</tenant_id>\\n <max_service_num>5</max_service_num>\\n <servicer_id>110002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:32</record_gmt_modified>\\n <pk_id>11000220210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107527601</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:31</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>念茹</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>念茹</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </30>\\n <31>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369001</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:38</record_gmt_modified>\\n <pk_id>36900120210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342401</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:36</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试003</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试003</servicer_name>\\n <servicer_rest_cnt>48</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </31>\\n <32>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369013</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:37</record_gmt_modified>\\n <pk_id>36901320210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107527801</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:37</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试015</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试015</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </32>\\n <33>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>411009</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 18:03:19</record_gmt_modified>\\n <pk_id>41100920210402</pk_id>\\n <record_gmt_create>2021-04-02 15:42:29</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-411009</workset_user_id>\\n <department_name>default</department_name>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>陈宇1</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <servicer_name>陈宇1</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-03 00:00:00</workset_end_date>\\n </33>\\n <34>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>335002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:19:57</record_gmt_modified>\\n <pk_id>33500220210401</pk_id>\\n <record_gmt_create>2020-09-08 14:08:06</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-335002</workset_user_id>\\n <department_name>default</department_name>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>99</servicer_status>\\n <servicer_real_name>班务自动化账号001</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>培训</servicer_status_name>\\n <servicer_name>班务自动化账号001</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2020-09-09 00:00:00</workset_end_date>\\n </34>\\n <35>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369014</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:01</record_gmt_modified>\\n <pk_id>36901420210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107708101</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:01</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试016</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:18:41</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试016</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </35>\\n <36>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>679089</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:22:46</record_gmt_modified>\\n <pk_id>67908920210401</pk_id>\\n <record_gmt_create>2021-04-01 23:15:27</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>1083001</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:15:27</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>马珍</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 18:07:47</fst_login_time>\\n <servicer_name>马珍</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </36>\\n <37>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>86001</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 16:13:36</record_gmt_modified>\\n <pk_id>8600120210401</pk_id>\\n <record_gmt_create>2021-04-01 16:02:01</record_gmt_create>\\n <department_id>112005</department_id>\\n <workset_user_id>107429901</workset_user_id>\\n <department_name>苗硕测试专用部门（勿加）</department_name>\\n <lst_login_time>2021-04-01 16:02:16</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>苗硕</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 16:02:01</fst_login_time>\\n <servicer_name>苗硕</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </37>\\n <38>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>679089</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 11:01:53</record_gmt_modified>\\n <pk_id>67908920210402</pk_id>\\n <record_gmt_create>2021-04-02 09:43:32</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107346101</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 10:57:33</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>马珍</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 09:43:32</fst_login_time>\\n <servicer_name>马珍</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </38>\\n <39>\\n <tenant_id>905</tenant_id>\\n <max_service_num>1</max_service_num>\\n <servicer_id>369002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:23:29</record_gmt_modified>\\n <pk_id>36900220210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107708201</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:23:29</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试004</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:52</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试004</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </39>\\n <40>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>335002</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:33</record_gmt_modified>\\n <pk_id>33500220210402</pk_id>\\n <record_gmt_create>2020-09-08 14:08:06</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-335002</workset_user_id>\\n <department_name>default</department_name>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>99</servicer_status>\\n <servicer_real_name>班务自动化账号001</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>培训</servicer_status_name>\\n <servicer_name>班务自动化账号001</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2020-09-09 00:00:00</workset_end_date>\\n </40>\\n <41>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369008</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:36</record_gmt_modified>\\n <pk_id>36900820210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342501</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:35</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试010</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试010</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </41>\\n <42>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369005</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 23:20:01</record_gmt_modified>\\n <pk_id>36900520210401</pk_id>\\n <record_gmt_create>2021-04-01 23:19:55</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107421101</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-01 23:20:01</lst_login_time>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试007</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-01 00:19:53</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试007</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 23:59:59</workset_end_date>\\n </42>\\n <43>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>411009</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-01 19:11:40</record_gmt_modified>\\n <pk_id>41100920210401</pk_id>\\n <record_gmt_create>2021-03-31 10:31:44</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>-411009</workset_user_id>\\n <department_name>default</department_name>\\n <date_id>20210401</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>陈宇1</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <servicer_name>陈宇1</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-01 00:00:00</workset_end_date>\\n </43>\\n <44>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369005</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:37</record_gmt_modified>\\n <pk_id>36900520210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107527701</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:36</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试007</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试007</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </44>\\n <45>\\n <tenant_id>905</tenant_id>\\n <max_service_num>3</max_service_num>\\n <servicer_id>369014</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <record_gmt_modified>2021-04-02 23:18:35</record_gmt_modified>\\n <pk_id>36901420210402</pk_id>\\n <record_gmt_create>2021-04-02 23:18:30</record_gmt_create>\\n <department_id>10</department_id>\\n <workset_user_id>107342301</workset_user_id>\\n <department_name>default</department_name>\\n <lst_login_time>2021-04-02 23:18:35</lst_login_time>\\n <date_id>20210402</date_id>\\n <speci_ability_status>0</speci_ability_status>\\n <current_service_num>0</current_service_num>\\n <servicer_status>D</servicer_status>\\n <servicer_real_name>商业化阿里云自动化测试016</servicer_real_name>\\n <current_speci_ability_num>0</current_speci_ability_num>\\n <servicer_status_name>离线</servicer_status_name>\\n <fst_login_time>2021-04-02 00:18:44</fst_login_time>\\n <servicer_name>商业化阿里云自动化测试016</servicer_name>\\n <servicer_rest_cnt>0</servicer_rest_cnt>\\n <max_speci_ability_num>1</max_speci_ability_num>\\n <workset_end_date>2021-04-02 23:59:59</workset_end_date>\\n </45>\\n </Rows>\\n</Data>\\n</GetOnlineSeatInformationResponse>","errorExample":""}]', - 'title' => 'GetOnlineSeatInformation', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"73****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"测试\\\\\\",\\\\\\"recordgmtmodified\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"7320372021****\\\\\\",\\\\\\"statusstarttime\\\\\\":\\\\\\"2021-04-01 11:36:50\\\\\\",\\\\\\"recordgmtcreate\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"94****\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"测试技能组\\\\\\",\\\\\\"lstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"triggerreason\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_status\\\\\\":\\\\\\"D\\\\\\",\\\\\\"assignstatus\\\\\\":\\\\\\"1\\\\\\",\\\\\\"servicerreal_name\\\\\\":\\\\\\"xx\\\\\\",\\\\\\"servicerstatusname\\\\\\":\\\\\\"签出\\\\\\",\\\\\\"fstlogintime\\\\\\":\\\\\\"2021-04-01 10:06:24\\\\\\",\\\\\\"servicer_name\\\\\\":\\\\\\"xx\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain Agent-Level Status Metrics for Hotline Monitoring ', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to provide agent or department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned Rows parameter:'."\n" + ."\n" + .' servicer_id: Agent ID '."\n" + .' servicer_name: Agent name '."\n" + .' servicer_real_name: Agent real name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' servicer_status: Hotline agent status '."\n" + .' servicer_status_name: Hotline agent status name '."\n" + .' status_start_time: Status start time '."\n" + .' assign_status: Assignment status '."\n" + .' rest_type: Break type'."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentBasisStatus'], + ], + ], + 'ramActions' => [], ], - 'GetQueueInformation' => [ - 'summary' => '技能组纬度队列信息', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentById' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6936,216 +4695,69 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], - ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组id列表', - 'type' => 'array', - ], - ], - [ - 'name' => 'ExistDepartmentGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ExistSkillGroupGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'fasle', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'name' => 'AgentId', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', + 'type' => 'object', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], + 'ForeignNick' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RealName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'AgentId' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ForeignKey' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ShowName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreateUserName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"current_session_wait_cnt\\\\\\":0,\\\\\\"current_session_service_cnt\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210327\\\\\\",\\\\\\"maximum_queuing_time\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQueueInformationResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>xxxx</Message>\\n <Code>200</Code>\\n <Success>true</Success>\\n <Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>{\\"tenant_id\\":\\"905\\",\\"tenant_name\\":\\"非单元测试化BU\\",\\"group_id\\":\\"-1\\",\\"group_name\\":\\"-1\\",\\"department_id\\":\\"-1\\",\\"department_name\\":\\"-1\\",\\"current_session_wait_cnt\\":0,\\"current_session_service_cnt\\":0,\\"date_id\\":\\"20210327\\",\\"maximum_queuing_time\\":-1}</Rows>\\n </Data>\\n</GetQueueInformationResponse>","errorExample":""}]', - 'title' => 'GetQueueInformation', - ], - 'GetSkillGroupStatusTotal' => [ - 'summary' => '技能组状态总量', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"ForeignNick\\": \\"\\",\\n \\"ServicerType\\": 0,\\n \\"RealName\\": \\"\\",\\n \\"AgentId\\": 0,\\n \\"ForeignKey\\": \\"\\",\\n \\"ShowName\\": \\"\\",\\n \\"CreateUserName\\": \\"\\"\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'GetAgentDetailReport' => [ + 'summary' => 'Retrieve the summary data of hotline agent details under hotline reports. Supports queries by instance, time range, agent, and department group.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7153,89 +4765,47 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The start date as a UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.'."\n", 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of agent IDs.', + 'items' => ['description' => 'Agent ID.'."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and view the **AgentId** in the response parameters to obtain the agent ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '坐席id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ @@ -7243,80 +4813,39 @@ 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '技能组id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'minute', - 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', - ], + 'schema' => ['description' => 'The time latitude type. Valid values:'."\n" + .'- **minute**: Minute.'."\n" + .'- **hour**: Hour.'."\n" + .'- **day**: Day.', 'example' => 'day', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据坐席分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to query by agent group. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'fasle', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'ExistSkillGroupGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'fasle', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to query by department group. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ @@ -7324,93 +4853,155 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'List of data. ', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int64', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int64', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>. ', 'example' => '{"t_wait":379322.0,"hotline_time_outcall_avg":"32.00","n_ringing":0,"t_outbound_40":0.0,"hotline_time_incall_avg":-1,"t_calldialing":0.0,"n_inbound":276,"servicer_id":"-1","call_in_sep_sat_cnt":13,"request_cnt":231,"n_not_ready_99":811,"t_work_outbound":49338.0,"hotline_rate_handle_in_60s":"96%","n_not_ready_login":811,"t_not_ready_login":0.0,"n_work_inbound":176,"}', 'title' => '', 'type' => 'string'], ], 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'string', - ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_out_intervene_servicer_cnt\\\\\\":26,\\\\\\"call_out_servicer_cnt\\\\\\":35,\\\\\\"call_out_intervene_60s_cnt\\\\\\":155,\\\\\\"servicer_real_name\\\\\\":\\\\\\"--\\\\\\",\\\\\\"call_in_sep_normal_cnt\\\\\\":0,\\\\\\"call_out_intervene_30s_cnt\\\\\\":235,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"call_out_sep_sat_cnt\\\\\\":1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupStatusTotalResponse>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <0>\\n <minute_id>-1</minute_id>\\n <call_out_intervene_servicer_cnt>26</call_out_intervene_servicer_cnt>\\n <call_out_servicer_cnt>35</call_out_servicer_cnt>\\n <call_out_intervene_60s_cnt>155</call_out_intervene_60s_cnt>\\n <servicer_real_name>--</servicer_real_name>\\n <call_in_sep_normal_cnt>0</call_in_sep_normal_cnt>\\n <call_out_intervene_30s_cnt>235</call_out_intervene_30s_cnt>\\n <servicer_id>-1</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <call_out_sep_sat_cnt>1</call_out_sep_sat_cnt>\\n <group_name>-1</group_name>\\n <call_in_sep_sat_cnt>0</call_in_sep_sat_cnt>\\n <inline_cnt>2</inline_cnt>\\n <request_cnt>2</request_cnt>\\n <call_out_ring_len>42885</call_out_ring_len>\\n <call_out_sep_unsat_cnt>0</call_out_sep_unsat_cnt>\\n <servicer_call_out_intervene_cnt>555</servicer_call_out_intervene_cnt>\\n <queue_len>6</queue_len>\\n <servicer_name>--</servicer_name>\\n <call_out_intervene_len>29081</call_out_intervene_len>\\n <servicer_call_out_cnt>1187</servicer_call_out_cnt>\\n <tenant_id>905</tenant_id>\\n <participation>0</participation>\\n <call_out_sep_normal_cnt>0</call_out_sep_normal_cnt>\\n <call_in_unsep_cnt>0</call_in_unsep_cnt>\\n <ready_cnt>2</ready_cnt>\\n <call_out_unsep_cnt>0</call_out_unsep_cnt>\\n <date_id>-1</date_id>\\n <abandonment_rate>0.00%</abandonment_rate>\\n <service_time_len>93</service_time_len>\\n <hour_id>-1</hour_id>\\n <participation_rate>0.00%</participation_rate>\\n <call_out_cnt>1187</call_out_cnt>\\n <call_in_intervene_20s_cnt>2</call_in_intervene_20s_cnt>\\n <ringtime_len>5</ringtime_len>\\n <call_out_intervene_cnt>555</call_out_intervene_cnt>\\n <call_in_intervene_60s_cnt>0</call_in_intervene_60s_cnt>\\n <department_id>-1</department_id>\\n <department_name>-1</department_name>\\n <call_out_all_len>42885</call_out_all_len>\\n <ringqueue_len>1</ringqueue_len>\\n <call_in_intervene_30s_cnt>2</call_in_intervene_30s_cnt>\\n <average_waiting_time>3</average_waiting_time>\\n <group_id>-1</group_id>\\n <sixty_seconds_response_rate>100%</sixty_seconds_response_rate>\\n <reassign_cnt>0</reassign_cnt>\\n <call_in_sep_unsat_cnt>0</call_in_sep_unsat_cnt>\\n <call_out_intervene_20s_cnt>283</call_out_intervene_20s_cnt>\\n <ready_cnt_60s>2</ready_cnt_60s>\\n </0>\\n </Rows>\\n</Data>\\n</GetSkillGroupStatusTotalResponse>","errorExample":""}]', - 'title' => 'GetSkillGroupStatusTotal', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"t_wait\\\\\\":379322.0,\\\\\\"hotline_time_outcall_avg\\\\\\":\\\\\\"32.00\\\\\\",\\\\\\"n_ringing\\\\\\":0,\\\\\\"t_outbound_40\\\\\\":0.0,\\\\\\"hotline_time_incall_avg\\\\\\":-1,\\\\\\"t_calldialing\\\\\\":0.0,\\\\\\"n_inbound\\\\\\":276,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_in_sep_sat_cnt\\\\\\":13,\\\\\\"request_cnt\\\\\\":231,\\\\\\"n_not_ready_99\\\\\\":811,\\\\\\"t_work_outbound\\\\\\":49338.0,\\\\\\"hotline_rate_handle_in_60s\\\\\\":\\\\\\"96%\\\\\\",\\\\\\"n_not_ready_login\\\\\\":811,\\\\\\"t_not_ready_login\\\\\\":0.0,\\\\\\"n_work_inbound\\\\\\":176,\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Retrieve summary data of hotline agent details under a hotline report', + 'description' => '- Before you invoke this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to provide agent or department information, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Response parameter Rows Parameter Guide:'."\n" + ."\n" + .' date_id: Date '."\n" + .' servicer_id: Service agent ID '."\n" + .' servicer_name: Agent Name '."\n" + .' servicer_real_name: Agent real name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department Name '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant Name '."\n" + .' n_consult: Consultation handling '."\n" + .' n_consult_made: Number of consultations initiated '."\n" + .' n_consult_take: Number of consultations accepted '."\n" + .' n_dialing: Dial-up Count '."\n" + .' n_hold: Hold Count '."\n" + .' n_inbound: Inbound call Count '."\n" + .' n_internal: Internal call volume '."\n" + .' n_internal_in: Internal inbound call volume '."\n" + .' n_internal_out: Internal outbound call volume '."\n" + .' n_not_ready: Total break Count '."\n" + .' n_not_ready_login: Softphone logon break Count '."\n" + .' n_outbound: Outbound call Count — dialed and connected '."\n" + .' n_ringing: Total ringing Count '."\n" + .' n_talk: Total talk Count '."\n" + .' n_wait: Wait Count '."\n" + .' n_work: Total post-processing Count (ACW) '."\n" + .' n_work_inbound: Total post-processing Count – inbound '."\n" + .' n_work_outbound: Total post-processing Count – outbound '."\n" + .' t_calldialing: Total dial-up duration '."\n" + .' t_consult: Consultation handling duration '."\n" + .' t_consult_made: Duration of consultations initiated '."\n" + .' t_consult_taken: Number of consultations accepted '."\n" + .' t_hold: Call hold duration '."\n" + .' t_inbound: Inbound duration '."\n" + .' t_internal: Internal call duration '."\n" + .' t_internal_in: Internal inbound duration '."\n" + .' t_internal_out: Internal outbound duration '."\n" + .' t_login: Total logon duration '."\n" + .' t_not_ready_login: Logon break duration '."\n" + .' t_outbound: Total outbound duration — dialed and connected '."\n" + .' t_ringing: Ringing duration '."\n" + .' t_talk: Total talk duration '."\n" + .' t_wait: Total idle duration '."\n" + .' t_work: Total post-processing duration '."\n" + .' t_work_inbound: Post-call duration (inbound) '."\n" + .' t_work_outbound: Post-call duration (outbound) '."\n" + .' t_not_ready: Total break duration '."\n" + .' t_not_ready_1: Regular break duration '."\n" + .' t_not_ready_2: Meal break duration '."\n" + .' t_not_ready_3: Meeting break duration '."\n" + .' t_not_ready_4: Coaching break duration '."\n" + .' t_not_ready_5: Training break duration '."\n" + .' t_not_ready_99: Agent sign-in break duration '."\n" + .' n_not_ready_1: Regular break Count '."\n" + .' n_not_ready_2: Meal break Count '."\n" + .' n_not_ready_3: Meeting break Count '."\n" + .' n_not_ready_4: Coaching break Count '."\n" + .' n_not_ready_5: Training break Count '."\n" + .' n_not_ready_99: Agent sign-in break Count '."\n" + .' n_inbound_40: Inbound calls with duration greater than 40 seconds '."\n" + .' t_inbound_40: Inbound duration, total duration of each inbound call longer than 40 seconds '."\n" + .' n_outbound_40: Outbound calls with duration greater than 40 seconds '."\n" + .' t_outbound_40: Outbound duration, total duration of each outbound call longer than 40 seconds '."\n" + .' n_outbound_dial: Outbound dial volume — counted as soon as dialed '."\n" + .' t_not_ready_sr: Break duration spent on tickets '."\n" + .' n_not_ready_sr: Break Count spent on tickets '."\n" + .' inline_cnt: Incoming call volume '."\n" + .' request_cnt: Request Count (processed volume minus reassigned volume) '."\n" + .' ready_cnt: Answered call Count '."\n" + .' reassign_cnt: Reassigned Count '."\n" + .' ready_cnt_60s: Calls answered within 60 seconds '."\n" + .' ringqueue_len: Duration from queue entry to ringing '."\n" + .' ringtime_len: Duration from ringing to answer '."\n" + .' queue_len: Duration from queue entry to answer '."\n" + .' service_time_len: Service duration from answer to end '."\n" + .' give_up_len: Total abandonment duration from queue entry to end '."\n" + .' call_out_cnt: Outbound call volume '."\n" + .' call_out_intervene_cnt: Outbound connected call volume '."\n" + .' call_out_ring_len: Total outbound ringing duration — from ringing to end '."\n" + .' call_out_all_len: Total outbound call duration — from start to end '."\n" + .' call_out_intervene_len: Outbound connected call duration — from answer to end '."\n" + .' call_out_sep_sat_cnt: Outbound — satisfied hotline evaluation Count '."\n" + .' call_out_sep_normal_cnt: Outbound — neutral hotline evaluation Count '."\n" + .' call_out_sep_unsat_cnt: Outbound — dissatisfied hotline evaluation Count '."\n" + .' call_out_unsep_cnt: Outbound — participated in evaluation but did not rate '."\n" + .' call_in_unsep_cnt: Inbound — participated in evaluation but did not rate '."\n" + .' call_in_sep_sat_cnt: Inbound — satisfied hotline evaluation Count '."\n" + .' call_in_sep_normal_cnt: Inbound — neutral hotline evaluation Count '."\n" + .' call_in_sep_unsat_cnt: Inbound — dissatisfied hotline evaluation Count '."\n" + .' call_out_intervene_20s_cnt: Outbound — connected calls with duration greater than 20 seconds '."\n" + .' call_out_intervene_30s_cnt: Outbound — connected calls with duration greater than 30 seconds '."\n" + .' call_out_intervene_60s_cnt: Outbound — connected calls with duration greater than 60 seconds '."\n" + .' call_in_intervene_20s_cnt: Inbound — connected calls with duration greater than 20 seconds '."\n" + .' call_in_intervene_30s_cnt: Inbound — connected calls with duration greater than 30 seconds '."\n" + .' call_in_intervene_60s_cnt: Inbound — connected calls with duration greater than 60 seconds', + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentDetailReport'], + ], + ], + 'ramActions' => [], ], - 'GetAgentDetailReport' => [ - 'summary' => '热线坐席纬度详情汇总', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentIndexRealTime' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7418,235 +5009,137 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**. ', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10', 'title' => ''], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '坐席id列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**. '."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'DepIds', 'in' => 'query', - 'style' => 'simple', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', + 'description' => 'List of department IDs. ', 'type' => 'array', - ], - ], - [ - 'name' => 'TimeLatitudeType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'day', - 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', - ], - ], - [ - 'name' => 'ExistAgentGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true/false', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](~~2717975~~) API and view the **DepartmentId** in the response parameters to obtain the department ID. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', 'title' => ''], 'required' => false, - 'title' => '是否根据坐席分组显示', - 'type' => 'boolean', + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExistDepartmentGrouping', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'true/false', + 'description' => 'List of skill group IDs. ', + 'type' => 'array', + 'items' => ['description' => 'Skill group ID. '."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](~~2717970~~) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', 'title' => ''], 'required' => false, - 'title' => '是否根据部门分组显示', - 'type' => 'boolean', + 'maxItems' => 200, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'Returned data.', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Data list.', + 'type' => 'object', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int64', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int64', - 'title' => '页大小', - 'type' => 'integer', + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Columns' => [ + 'description' => 'Description of returned columns.', + 'type' => 'array', + 'items' => [ + 'description' => 'Metric data.', + 'type' => 'object', + 'properties' => [ + 'Title' => ['description' => 'Metric description.', 'type' => 'string', 'example' => 'servicerId', 'title' => ''], + 'Key' => ['description' => 'Metric.', 'type' => 'string', 'example' => '客服ID', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Page' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Rows' => [ - 'description' => '', - 'example' => '{"t_wait":379322.0,"hotline_time_outcall_avg":"32.00","n_ringing":0,"t_outbound_40":0.0,"hotline_time_incall_avg":-1,"t_calldialing":0.0,"n_inbound":276,"servicer_id":"-1","call_in_sep_sat_cnt":13,"request_cnt":231,"n_not_ready_99":811,"t_work_outbound":49338.0,"hotline_rate_handle_in_60s":"96%","n_not_ready_login":811,"t_not_ready_login":0.0,"n_work_inbound":176,"}', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', + 'description' => 'Returned data results.', + 'type' => 'array', + 'items' => ['description' => 'Query result data. ', 'type' => 'object', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. '."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"t_wait\\\\\\":379322.0,\\\\\\"hotline_time_outcall_avg\\\\\\":\\\\\\"32.00\\\\\\",\\\\\\"n_ringing\\\\\\":0,\\\\\\"t_outbound_40\\\\\\":0.0,\\\\\\"hotline_time_incall_avg\\\\\\":-1,\\\\\\"t_calldialing\\\\\\":0.0,\\\\\\"n_inbound\\\\\\":276,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_in_sep_sat_cnt\\\\\\":13,\\\\\\"request_cnt\\\\\\":231,\\\\\\"n_not_ready_99\\\\\\":811,\\\\\\"t_work_outbound\\\\\\":49338.0,\\\\\\"hotline_rate_handle_in_60s\\\\\\":\\\\\\"96%\\\\\\",\\\\\\"n_not_ready_login\\\\\\":811,\\\\\\"t_not_ready_login\\\\\\":0.0,\\\\\\"n_work_inbound\\\\\\":176,\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <t_wait>379322</t_wait>\\n <hotline_time_outcall_avg>32.00</hotline_time_outcall_avg>\\n <n_ringing>0</n_ringing>\\n <t_outbound_40>0</t_outbound_40>\\n <hotline_time_incall_avg>-1</hotline_time_incall_avg>\\n <t_calldialing>0</t_calldialing>\\n <n_inbound>276</n_inbound>\\n <servicer_id>-1</servicer_id>\\n <call_in_sep_sat_cnt>13</call_in_sep_sat_cnt>\\n <request_cnt>231</request_cnt>\\n <n_not_ready_99>811</n_not_ready_99>\\n <t_work_outbound>49338</t_work_outbound>\\n <hotline_rate_handle_in_60s>96%</hotline_rate_handle_in_60s>\\n <n_not_ready_login>811</n_not_ready_login>\\n <t_not_ready_login>0</t_not_ready_login>\\n <n_work_inbound>176</n_work_inbound>\\n <n_outbound_40>0</n_outbound_40>\\n <call_out_intervene_len>21210</call_out_intervene_len>\\n <n_dialing>0</n_dialing>\\n <tenant_id>905</tenant_id>\\n <hotline_time_acw_incall>4.91</hotline_time_acw_incall>\\n <t_work_inbound>864</t_work_inbound>\\n <hotline_time_acw_outcall>120.93</hotline_time_acw_outcall>\\n <call_out_sep_normal_cnt>0</call_out_sep_normal_cnt>\\n <t_outbound>20281</t_outbound>\\n <call_out_unsep_cnt>0</call_out_unsep_cnt>\\n <date_id>-1</date_id>\\n <t_login>720474</t_login>\\n <participation_rate>11.92%</participation_rate>\\n <call_in_intervene_20s_cnt>62</call_in_intervene_20s_cnt>\\n <call_out_intervene_cnt>451</call_out_intervene_cnt>\\n <t_inbound_40>0</t_inbound_40>\\n <t_ringing>0</t_ringing>\\n <department_id>-1</department_id>\\n <n_work>641</n_work>\\n <department_name>-1</department_name>\\n <call_out_all_len>33539</call_out_all_len>\\n <t_consult>0</t_consult>\\n <call_in_intervene_30s_cnt>50</call_in_intervene_30s_cnt>\\n <call_in_sep_unsat_cnt>5</call_in_sep_unsat_cnt>\\n <ready_cnt_60s>185</ready_cnt_60s>\\n <t_not_ready_3>5</t_not_ready_3>\\n <n_wait>1558</n_wait>\\n <t_not_ready_4>387</t_not_ready_4>\\n <t_not_ready_5>0</t_not_ready_5>\\n <t_internal>0</t_internal>\\n <n_not_ready_5>0</n_not_ready_5>\\n <n_not_ready_3>1</n_not_ready_3>\\n <n_not_ready_4>2</n_not_ready_4>\\n <break_ratio>-1</break_ratio>\\n <n_not_ready_1>1047</n_not_ready_1>\\n <call_out_intervene_60s_cnt>128</call_out_intervene_60s_cnt>\\n <servicer_real_name>-1</servicer_real_name>\\n <n_work_outbound>408</n_work_outbound>\\n <n_not_ready_2>1</n_not_ready_2>\\n <t_work>66844</t_work>\\n <call_in_sep_normal_cnt>5</call_in_sep_normal_cnt>\\n <n_not_ready_0>0</n_not_ready_0>\\n <n_internal>0</n_internal>\\n <call_out_intervene_30s_cnt>184</call_out_intervene_30s_cnt>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <call_out_sep_sat_cnt>0</call_out_sep_sat_cnt>\\n <n_internal_in>0</n_internal_in>\\n <inline_cnt>276</inline_cnt>\\n <n_consult_take>0</n_consult_take>\\n <call_out_ring_len>33539</call_out_ring_len>\\n <call_out_sep_unsat_cnt>0</call_out_sep_unsat_cnt>\\n <n_outbound_dial>0</n_outbound_dial>\\n <give_up_len>2257</give_up_len>\\n <queue_len>3484</queue_len>\\n <n_consult>0</n_consult>\\n <t_not_ready_99>1232</t_not_ready_99>\\n <servicer_name>-1</servicer_name>\\n <t_not_ready_0>0</t_not_ready_0>\\n <t_not_ready_1>4349</t_not_ready_1>\\n <t_not_ready_2>14</t_not_ready_2>\\n <t_consult_made>0</t_consult_made>\\n <evaluate_cnt>23</evaluate_cnt>\\n <n_consult_made>0</n_consult_made>\\n <call_in_unsep_cnt>0</call_in_unsep_cnt>\\n <ready_cnt>193</ready_cnt>\\n <service_time_len>6784</service_time_len>\\n <n_hold>0</n_hold>\\n <n_internal_out>0</n_internal_out>\\n <n_not_ready>268</n_not_ready>\\n <n_inbound_40>0</n_inbound_40>\\n <t_internal_in>0</t_internal_in>\\n <call_out_cnt>1048</call_out_cnt>\\n <t_consult_taken>0</t_consult_taken>\\n <t_inbound>6784</t_inbound>\\n <ringtime_len>984</ringtime_len>\\n <call_in_intervene_60s_cnt>30</call_in_intervene_60s_cnt>\\n <t_internal_out>0</t_internal_out>\\n <ringqueue_len>3181</ringqueue_len>\\n <n_not_ready_sr>0</n_not_ready_sr>\\n <t_talk>0</t_talk>\\n <t_not_ready_sr>0</t_not_ready_sr>\\n <t_hold>0</t_hold>\\n <reassign_cnt>45</reassign_cnt>\\n <call_out_intervene_20s_cnt>224</call_out_intervene_20s_cnt>\\n <n_outbound>670</n_outbound>\\n <n_talk>0</n_talk>\\n <t_not_ready>5987</t_not_ready>\\n </Rows>\\n</Data>","errorExample":""}]', - 'title' => 'GetAgentDetailReport', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 4,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"servicerId\\",\\n \\"Key\\": \\"客服ID\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain real-time data details of hotline agents ', + 'summary' => 'Obtain real-time agent detail data grouped by instance, department, and skill group (real-time data).', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn).'."\n" + .'- If you need to specify department or skill group information, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 10 requests per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetSkillGroupServiceStatus' => [ - 'summary' => '技能组服务状态量', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentServiceStatus' => [ + 'summary' => 'Obtain the agent service status metrics from online reports. Supports queries by instance, time range, agent, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7654,89 +5147,47 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The start UNIX timestamp, in milliseconds. ', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**. ', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**. ', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of agent IDs. ', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response to obtain the agent ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '技能组id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ @@ -7744,196 +5195,143 @@ 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '部门id列表', - 'type' => 'array', - ], - ], - [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'A list of department IDs. ', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID. ', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '技能组id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'minute', - 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', - ], - ], - [ - 'name' => 'ExistAgentGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The time latitude type. Valid values: '."\n" + .'- **minute**: Minute '."\n" + .'- **hour**: Hour '."\n" + .'- **day**: Day ', 'example' => 'minute', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Whether to query by department group. Default Value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'ExistSkillGroupGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据技能组分组', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'ExistRobotInstanceGrouping', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据机器实例分组', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'ExistChannelInstanceGrouping', + 'name' => 'ExistAgentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'title' => '是否根据渠道实例分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Whether to query by agent group. Default Value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误描述', - 'type' => 'string', - ], + 'Message' => ['description' => 'Status code description. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Data list. ', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int32', - 'title' => '页大小', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'Information provided as a JSON string of type List<Map>. ', 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', 'title' => '', 'type' => 'string'], ], 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'string', - ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], - 'title' => 'Schema of Response', + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageSize\\": 2000,\\n \\"PageNum\\": 1,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":382,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":\\\\\\"0.39\\\\\\",\\\\\\"service_pickup\\\\\\":\\\\\\"7752\\\\\\",\\\\\\"online_service_time_len\\\\\\":220753,\\\\\\"online_direct_give_up_len\\\\\\":1187,\\\\\\"channel_instance_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_30s_transfer_ready_cnt\\\\\\":382}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetSkillGroupServiceStatusResponse>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Message>xxxx</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <Page>1</Page>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <online_40s_transfer_ready_cnt>382</online_40s_transfer_ready_cnt>\\n <minute_id>-1</minute_id>\\n <online_unsatis_cnt>0</online_unsatis_cnt>\\n <online_simple_cnt>0</online_simple_cnt>\\n <average_queue_time>0.39</average_queue_time>\\n <service_pickup>7752</service_pickup>\\n <online_service_time_len>220753</online_service_time_len>\\n <online_direct_give_up_len>1187</online_direct_give_up_len>\\n <channel_instance_name>-1</channel_instance_name>\\n <servicer_id>-1</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <group_name>-1</group_name>\\n <online_30s_transfer_ready_cnt>382</online_30s_transfer_ready_cnt>\\n <online_direct_response_times>551</online_direct_response_times>\\n <online_direct_give_up_cnt>2242</online_direct_give_up_cnt>\\n <channel_instance_id>-1</channel_instance_id>\\n <online_transfer_wait_len>177</online_transfer_wait_len>\\n <servicer_name>马珍4号</servicer_name>\\n <robot_instance_id>-1</robot_instance_id>\\n <tenant_id>905</tenant_id>\\n <participation>2</participation>\\n <_30_seconds_pick_up_rate>75.21%</_30_seconds_pick_up_rate>\\n <online_transfer_response_times>2</online_transfer_response_times>\\n <pickup_rate>75.21%</pickup_rate>\\n <date_id>-1</date_id>\\n <online_20s_transfer_ready_cnt>382</online_20s_transfer_ready_cnt>\\n <online_transfer_give_up_cnt>313</online_transfer_give_up_cnt>\\n <hour_id>-1</hour_id>\\n <online_10s_transfer_ready_cnt>382</online_10s_transfer_ready_cnt>\\n <online_direct_request_cnt>9612</online_direct_request_cnt>\\n <online_60s_transfer_ready_cnt>382</online_60s_transfer_ready_cnt>\\n <service_request_volume>10307</service_request_volume>\\n <robot_instance_name>-1</robot_instance_name>\\n <participation_rate>0.00%</participation_rate>\\n <online_direct_ready_cnt>7370</online_direct_ready_cnt>\\n <online_transfer_out_cnt>695</online_transfer_out_cnt>\\n <online_transfer_in_give_up_cnt>313</online_transfer_in_give_up_cnt>\\n <online_transfer_response_len>9</online_transfer_response_len>\\n <online_20s_direct_ready_cnt>7370</online_20s_direct_ready_cnt>\\n <online_30s_direct_ready_cnt>7370</online_30s_direct_ready_cnt>\\n <_30_seconds_to_pick_up>7752</_30_seconds_to_pick_up>\\n <online_10s_direct_ready_cnt>7367</online_10s_direct_ready_cnt>\\n <online_direct_wait_len>3852</online_direct_wait_len>\\n <department_id>-1</department_id>\\n <department_name>-1</department_name>\\n <satisfaction>-1</satisfaction>\\n <online_transfer_ready_cnt>382</online_transfer_ready_cnt>\\n <online_transfer_give_up_len>3907</online_transfer_give_up_len>\\n <average_response_time>4.84</average_response_time>\\n <online_direct_response_len>2667</online_direct_response_len>\\n <group_id>-1</group_id>\\n <online_transfer_request_cnt>695</online_transfer_request_cnt>\\n <give_up>2555</give_up>\\n <online_satis_cnt>2</online_satis_cnt>\\n <online_60s_direct_ready_cnt>7370</online_60s_direct_ready_cnt>\\n <online_40s_direct_ready_cnt>7370</online_40s_direct_ready_cnt>\\n <average_abandon_time>0.49</average_abandon_time>\\n </Rows>\\n</Data>\\n</GetSkillGroupServiceStatusResponse>","errorExample":""}]', - 'title' => 'GetSkillGroupServiceStatus', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":81,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":-1,\\\\\\"service_pickup\\\\\\":\\\\\\"2086\\\\\\",\\\\\\"total_waiting_time\\\\\\":\\\\\\"981\\\\\\",\\\\\\"online_service_time_len\\\\\\":58208,\\\\\\"online_direct_give_up_len\\\\\\":0,\\\\\\"break_ratio\\\\\\":\\\\\\"2%\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve Agent Service Status Metrics from Online Reports ', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to provide agent or department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 queries per second.'."\n" + .'- API-wide invocation frequency: 100 queries per second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned Rows parameter:'."\n" + ."\n" + .' date_id: Date '."\n" + .' hour_id: Hour '."\n" + .' minute_id: Minute—5-minute intervals, such as 05, 10, 00, 15 '."\n" + .' servicer_id: Agent ID '."\n" + .' servicer_name: Agent Name '."\n" + .' servicer_real_name: Agent Real Name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department Name '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant Name '."\n" + .' online_direct_ready_cnt: Service volume directly accepted by the agent (direct connection) '."\n" + .' online_transfer_ready_cnt: Service volume accepted after transfer-in '."\n" + .' online_transfer_in_give_up_cnt: User abandonment count after transfer (not accepted) '."\n" + .' online_transfer_out_cnt: Total transfer-out count (it is recommended to obtain this metric directly via the mark action recorded in the product) '."\n" + .' online_direct_give_up_cnt: Abandonment count (direct connection)—requests directly abandoned '."\n" + .' online_transfer_give_up_cnt: Abandonment count (transfer-in)—abandoned after transfer-in '."\n" + .' online_10s_direct_ready_cnt: Service volume accepted within 10 seconds (direct connection) '."\n" + .' online_10s_transfer_ready_cnt: Service volume accepted within 10 seconds (transfer-in) '."\n" + .' online_20s_direct_ready_cnt: Service volume accepted within 20 seconds (direct connection) '."\n" + .' online_20s_transfer_ready_cnt: Service volume accepted within 20 seconds (transfer-in) '."\n" + .' online_30s_direct_ready_cnt: Service volume accepted within 30 seconds (direct connection) '."\n" + .' online_30s_transfer_ready_cnt: Service volume accepted within 30 seconds (transfer-in) '."\n" + .' online_40s_direct_ready_cnt: Service volume accepted within 40 seconds (direct connection) '."\n" + .' online_40s_transfer_ready_cnt: Service volume accepted within 40 seconds (transfer-in) '."\n" + .' online_60s_direct_ready_cnt: Service volume accepted within 60 seconds (direct connection) '."\n" + .' online_60s_transfer_ready_cnt: Service volume accepted within 60 seconds (transfer-in) '."\n" + .' online_service_time_len: Total service duration—the time from when the agent started serving to when the service ended (if a change owner occurred, the service end time equals the transfer time), corresponding to the skill group '."\n" + .' online_direct_wait_len: Total waiting duration (direct connection)—from queue entry to acceptance for direct connections '."\n" + .' online_transfer_wait_len: Total waiting duration (transfer-in)—from queue entry to acceptance for transfer-ins '."\n" + .' online_direct_give_up_len: Total abandonment duration (direct connection)—from queue entry to abandonment for direct connections '."\n" + .' online_transfer_give_up_len: Total abandonment duration (transfer-in)—from queue entry to abandonment for transfer-ins (if abandonment occurs, its duration is counted under the last target skill group) '."\n" + .' online_direct_response_len: Response duration (direct connection)—average Recency between the Membership’s message and the agent’s reply '."\n" + .' online_transfer_response_len: Response duration (transfer-in)—average Recency between the Membership’s message and the agent’s reply '."\n" + .' online_direct_response_times: Response Count (direct connection)—number of intervals between the Membership’s message and the agent’s reply '."\n" + .' online_transfer_response_times: Response Count (transfer-in)—number of intervals between the Membership’s message and the agent’s reply '."\n" + .' online_satis_cnt: Satisfied Count—based on touch evaluations '."\n" + .' online_simple_cnt: Neutral Count—based on touch evaluations '."\n" + .' online_unsatis_cnt: Dissatisfied Count—based on touch evaluations '."\n" + .' t_login: Total logon duration '."\n" + .' t_rest: Total break duration', + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentServiceStatus'], + ], + ], + 'ramActions' => [], ], - 'GetAgentServiceStatus' => [ - 'summary' => '坐席服务状态量', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentStatistics' => [ + 'summary' => 'Obtain agent-level statistics under hotline monitoring. Supports querying by instance, time range, agent, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7941,89 +5339,47 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => 'AICCS实例ID，在智能联络中心控制台上可以看到', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '开始日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Start UNIX timestamp, in milliseconds. ', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '结束日期时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'End Datetime Variable as a UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'title' => '每页大小（默认为10)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '当前页（默认为1）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'AgentIds', 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'List of agent IDs.', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response to obtain the agent ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '坐席id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ @@ -8031,1102 +5387,676 @@ 'in' => 'query', 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'title' => '部门id列表', + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ 'name' => 'TimeLatitudeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'minute', - 'required' => false, - 'title' => '时间纬度类型', - 'type' => 'string', - ], + 'schema' => ['description' => 'Time latitude type. Valid values: '."\n" + ."\n" + .'- **minute**: minute '."\n" + .'- **hour**: hour', 'example' => 'minute', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据部门分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Indicates whether to query by department grouping. Valid values: '."\n" + ."\n" + .'- **true**: Yes '."\n" + .'- **false**: No', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ 'name' => 'ExistAgentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'title' => '是否根据坐席分组', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Whether to query by agent group. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '错误描述', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID，用于跟踪错误原因', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Data list. ', 'properties' => [ - 'TotalNum' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int64', - 'title' => '总记录数', - 'type' => 'integer', - ], - 'PageNum' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '2000', - 'format' => 'int64', - 'title' => '页大小', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', - 'title' => '信息为list<map>类型的json字符串', - 'type' => 'string', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'Information is a JSON string of type List<Map>. ', 'example' => '{"n_resttype_1":15,"t_outcall_speak":829747,"average_incoming_time":"8451.29","n_resttype_3":0,"minute_id":"-1","n_conference_speak":0,"n_resttype_2":0,"n_resttype_5":0,"n_resttype_4":0,"n_resttype_7":0,"n_resttype_6":0,"n_resttype_9":0,"n_resttype_8":0,"n_outcall_dial":25,"total_break_time":"58555","n_internal_speak":0,"n_send_step_transfer":7,"n_consulted_internal_speak":0}', 'title' => '', 'type' => 'string'], ], 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误编码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用接口是否成功', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. '."\n", 'example' => 'true', 'title' => '', 'type' => 'string'], ], - 'title' => 'result', + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":81,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":-1,\\\\\\"service_pickup\\\\\\":\\\\\\"2086\\\\\\",\\\\\\"total_waiting_time\\\\\\":\\\\\\"981\\\\\\",\\\\\\"online_service_time_len\\\\\\":58208,\\\\\\"online_direct_give_up_len\\\\\\":0,\\\\\\"break_ratio\\\\\\":\\\\\\"2%\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAgentServiceStatusResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <PageNum>1</PageNum>\\n <PageSize>2000</PageSize>\\n <TotalNum>4</TotalNum>\\n <Rows>\\n <0>\\n <online_40s_transfer_ready_cnt>81</online_40s_transfer_ready_cnt>\\n <minute_id>-1</minute_id>\\n <online_unsatis_cnt>0</online_unsatis_cnt>\\n <online_simple_cnt>0</online_simple_cnt>\\n <average_queue_time>-1</average_queue_time>\\n <service_pickup>2086</service_pickup>\\n <total_waiting_time>981</total_waiting_time>\\n <online_service_time_len>58208</online_service_time_len>\\n <online_direct_give_up_len>0</online_direct_give_up_len>\\n <break_ratio>2%</break_ratio>\\n <servicer_real_name>--</servicer_real_name>\\n <att>27.90</att>\\n <servicer_id>-1</servicer_id>\\n <tenant_name>非单元测试化BU</tenant_name>\\n <online_30s_transfer_ready_cnt>81</online_30s_transfer_ready_cnt>\\n <online_direct_response_times>119</online_direct_response_times>\\n <online_direct_give_up_cnt>0</online_direct_give_up_cnt>\\n <online_transfer_wait_len>33</online_transfer_wait_len>\\n <servicer_name>--</servicer_name>\\n <tenant_id>905</tenant_id>\\n <participation>1</participation>\\n <_30_seconds_pick_up_rate>-1</_30_seconds_pick_up_rate>\\n <online_transfer_response_times>0</online_transfer_response_times>\\n <pickup_rate>-1</pickup_rate>\\n <date_id>-1</date_id>\\n <t_login>17605</t_login>\\n <online_20s_transfer_ready_cnt>81</online_20s_transfer_ready_cnt>\\n <online_transfer_give_up_cnt>0</online_transfer_give_up_cnt>\\n <hour_id>-1</hour_id>\\n <online_10s_transfer_ready_cnt>81</online_10s_transfer_ready_cnt>\\n <online_60s_transfer_ready_cnt>81</online_60s_transfer_ready_cnt>\\n <participation_rate>0.00%</participation_rate>\\n <online_direct_ready_cnt>2005</online_direct_ready_cnt>\\n <online_transfer_out_cnt>151</online_transfer_out_cnt>\\n <t_rest>305</t_rest>\\n <online_transfer_in_give_up_cnt>0</online_transfer_in_give_up_cnt>\\n <online_transfer_response_len>0</online_transfer_response_len>\\n <online_20s_direct_ready_cnt>2005</online_20s_direct_ready_cnt>\\n <online_30s_direct_ready_cnt>2005</online_30s_direct_ready_cnt>\\n <_30_seconds_to_pick_up>2086</_30_seconds_to_pick_up>\\n <online_10s_direct_ready_cnt>2004</online_10s_direct_ready_cnt>\\n <online_direct_wait_len>948</online_direct_wait_len>\\n <department_id>-1</department_id>\\n <department_name>-1</department_name>\\n <satisfaction>-1</satisfaction>\\n <online_transfer_ready_cnt>81</online_transfer_ready_cnt>\\n <online_transfer_give_up_len>0</online_transfer_give_up_len>\\n <average_response_time>5.76</average_response_time>\\n <online_direct_response_len>685</online_direct_response_len>\\n <give_up>-1</give_up>\\n <online_satis_cnt>1</online_satis_cnt>\\n <online_60s_direct_ready_cnt>2005</online_60s_direct_ready_cnt>\\n <CPH>426.56</CPH>\\n <online_40s_direct_ready_cnt>2005</online_40s_direct_ready_cnt>\\n <average_abandon_time>-1</average_abandon_time>\\n </0>\\n </Rows>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetAgentServiceStatusResponse>","errorExample":""}]', - 'title' => 'GetAgentServiceStatus', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"n_resttype_1\\\\\\":15,\\\\\\"t_outcall_speak\\\\\\":829747,\\\\\\"average_incoming_time\\\\\\":\\\\\\"8451.29\\\\\\",\\\\\\"n_resttype_3\\\\\\":0,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_conference_speak\\\\\\":0,\\\\\\"n_resttype_2\\\\\\":0,\\\\\\"n_resttype_5\\\\\\":0,\\\\\\"n_resttype_4\\\\\\":0,\\\\\\"n_resttype_7\\\\\\":0,\\\\\\"n_resttype_6\\\\\\":0,\\\\\\"n_resttype_9\\\\\\":0,\\\\\\"n_resttype_8\\\\\\":0,\\\\\\"n_outcall_dial\\\\\\":25,\\\\\\"total_break_time\\\\\\":\\\\\\"58555\\\\\\",\\\\\\"n_internal_speak\\\\\\":0,\\\\\\"n_send_step_transfer\\\\\\":7,\\\\\\"n_consulted_internal_speak\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain agent-level statistics under hotline monitoring ', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify agent or department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.', + 'responseParamsDescription' => 'Description of the Rows parameter in the response:'."\n" + ."\n" + .' t_incall_ring: Incoming ring duration '."\n" + .' t_incall_speak: Incoming call duration '."\n" + .' t_outcall_dial: Dial-up duration (external) '."\n" + .' t_outcall_speak: Outgoing call duration '."\n" + .' t_internal_dial: Internal dial-up duration '."\n" + .' t_internal_speak: Internal call duration '."\n" + .' t_internal_ring: Internal ring duration '."\n" + .' t_consult_internal_speak: Consultation duration (internal) '."\n" + .' t_consulted_internal_ring: Ring duration when consulted (internal) '."\n" + .' t_consulted_internal_speak: Duration when consulted (internal) '."\n" + .' t_consult_external_speak: Consultation duration (external) '."\n" + .' t_conference_speak: Conference duration '."\n" + .' t_hold: Hold duration '."\n" + .' t_held: Duration held by others '."\n" + .' t_login: Logon duration '."\n" + .' t_resttype_1: Regular break duration '."\n" + .' t_resttype_2: Meal break duration '."\n" + .' t_resttype_3: Meeting break duration '."\n" + .' t_resttype_4: Coaching break duration '."\n" + .' t_resttype_5: Training break duration '."\n" + .' t_resttype_98: System-forced break duration '."\n" + .' t_resttype_99: Agent sign-in break duration '."\n" + .' t_idle: Idle duration '."\n" + .' t_acw: Post-processing duration (outbound) '."\n" + .' t_outcall_acw_end: Outbound post-processing duration '."\n" + .' t_incall_acw_end: Inbound post-processing duration '."\n" + .' n_incall_ring: Number of incoming rings '."\n" + .' n_incall_speak: Number of incoming calls '."\n" + .' n_outcall_dial: Number of dial-up attempts (external) '."\n" + .' n_outcall_speak: Number of outgoing calls '."\n" + .' n_internal_dial: Number of internal dial-up attempts '."\n" + .' n_internal_speak: Number of internal calls '."\n" + .' n_internal_ring: Number of internal rings '."\n" + .' n_consult_internal_dial: Number of consultation requests initiated (internal) '."\n" + .' n_consult_internal_speak: Number of consultations (internal) '."\n" + .' n_consulted_internal_ring: Number of rings received during consultation (internal) '."\n" + .' n_consulted_internal_speak: Number of times consulted (internal) '."\n" + .' n_consult_external_dial: Number of consultation requests initiated (external) '."\n" + .' n_consult_external_speak: Number of consultations (external) '."\n" + .' n_send_conference: Number of conferences initiated '."\n" + .' n_conference_speak: Number of conferences '."\n" + .' n_send_step_transfer: Number of single-step transfers initiated '."\n" + .' n_send_finish_transfer: Number of two-step transfers '."\n" + .' n_send_monitor_error: Number of failed monitoring attempts '."\n" + .' n_hold: Number of holds '."\n" + .' n_held: Number of times held by others '."\n" + .' n_resttype_1: Number of regular breaks '."\n" + .' n_resttype_2: Number of meal breaks '."\n" + .' n_resttype_3: Number of meeting breaks '."\n" + .' n_resttype_4: Number of coaching breaks '."\n" + .' n_resttype_5: Number of training breaks '."\n" + .' n_resttype_98: Number of system-forced breaks '."\n" + .' n_resttype_99: Number of agent sign-in breaks '."\n" + .' n_acw: Number of post-processing actions '."\n" + .' n_outcall_acw_end: Number of post-processing actions for outbound calls '."\n" + .' n_incall_acw_end: Number of post-processing actions for inbound calls '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatistics'], + ], + ], + 'ramActions' => [], ], - 'CreateAgent' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAiOutboundTaskBizData' => [ + 'summary' => 'Query the business information associated with this call by instance ID and session ID.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '15515', - 'abilityTreeNodes' => [ - 'FEATUREaiccsDTMAFT', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'js sdk中自动生成的鉴权token', - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'username@example.com', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'format' => 'int64', - 'items' => [ - 'description' => '', - 'example' => '1234****', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'SkillGroupIdList', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'format' => 'int64', - 'items' => [ - 'description' => '', - 'example' => '1223****,1456****', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => ['description' => 'Session ID.', 'example' => '123456', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '2578****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'The business information associated with this call.', + 'properties' => [ + 'BizData' => ['description' => 'Custom business information.', 'example' => '{"customer":123}', 'title' => '', 'type' => 'string'], + 'TaskId' => ['description' => 'The job ID.', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PhoneNum' => ['description' => 'The outbound phone number.', 'example' => '158****0000', 'title' => '', 'type' => 'string'], + 'CaseId' => ['description' => 'The Activity ID associated with this outbound call.', 'example' => '123', 'format' => 'int64', 'title' => 'id', 'type' => 'integer'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"BizData\\": \\"{\\\\\\"customer\\\\\\":123}\\",\\n \\"TaskId\\": 123456,\\n \\"PhoneNum\\": \\"158****0000\\",\\n \\"CaseId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query the business information associated with this call', + 'description' => '### Queries per second (QPS) limits'."\n" + .'- Call frequency per user: 100 times/second.'."\n" + .'- API call frequency: 100 times/second.'."\n" + ."\n" + .'> If the total calls from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskBizData'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 0,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateAgentResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</CreateAgentResponse>","errorExample":""}]', - 'title' => 'CreateAgent', + 'ramActions' => [], ], - 'DeleteAgent' => [ - 'summary' => '删除坐席账号', - 'methods' => [ - 'delete', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAiOutboundTaskDetail' => [ + 'summary' => 'Obtain the outbound call job details by instance ID and job ID. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '15536', - 'abilityTreeNodes' => [ - 'FEATUREaiccsTY5M4L', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298****', - 'required' => false, - 'title' => 'js sdk中自动生成的鉴权token', - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). '."\n", 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'AccountName', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Job ID. '."\n" + ."\n" + .'You can call the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or call the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response. ', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Outbound call job details. ', + 'properties' => [ + 'Status' => ['description' => 'Job status. Valid values: '."\n" + ."\n" + .'- **0**: Not started. '."\n" + .'- **1**: In progress. '."\n" + .'- **2**: System paused. '."\n" + .'- **3**: Manually paused. '."\n" + .'- **4**: Completed. '."\n" + .'- **5**: Stopped. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'HandlerId' => ['description' => 'Skill group ID (for predictive outbound calls) or IVR ID (for automated outbound calls). ', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'TaskId' => ['description' => 'Job ID. ', 'example' => '123', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Description' => ['description' => 'Job description. ', 'example' => '房产销售', 'title' => '', 'type' => 'string'], + 'Name' => ['description' => 'Job name. ', 'example' => 'xxxxx外呼', 'title' => '', 'type' => 'string'], + 'StatusDesc' => ['description' => 'Task status description.', 'example' => '未开始', 'title' => '', 'type' => 'string'], + 'ExecutionTime' => ['description' => 'Task execution time.', 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', 'title' => '', 'type' => 'string'], + 'Type' => ['description' => 'Task Type. Valid values:'."\n" + ."\n" + .'- **2**: Predictive outbound call.'."\n" + .'- **3**: Automated outbound call.'."\n", 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ConcurrentRate' => ['description' => 'Concurrency for automated outbound calls.', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'NumRepeated' => ['description' => 'Called number deduplication policy.'."\n" + ."\n" + .'- **0**: Remove duplicates.'."\n" + .'- **1**: Do not remove duplicates.'."\n", 'example' => '0', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'OutboundNums' => [ + 'description' => 'Outbound caller numbers.', + 'items' => ['description' => 'Outbound caller number.', 'example' => '150****0000', 'type' => 'string', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'RecallRule' => [ + 'description' => 'Failed-call retry policy.', + 'properties' => [ + 'Count' => ['description' => 'Number of retries.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Interval' => ['description' => 'Recall interval. Unit: minutes. ', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', + ], + 'HandlerName' => ['description' => 'Skill group name or IVR name. ', 'example' => '热线技能组', 'title' => '', 'type' => 'string'], + 'ForecastCallRate' => ['description' => 'Fixed outbound call ratio for predictive dialing. ', 'example' => '1.2', 'format' => 'float', 'title' => '', 'type' => 'number'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + '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.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"HandlerId\\": 123456,\\n \\"TaskId\\": 123,\\n \\"Description\\": \\"房产销售\\",\\n \\"Name\\": \\"xxxxx外呼\\",\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"ExecutionTime\\": \\"{\\\\\\"TUESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"06:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"06:05\\\\\\"}],\\\\\\"MONDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"20:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"21:45\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"22:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"22:50\\\\\\"}],\\\\\\"WEDNESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"THURSDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"FRIDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SATURDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SUNDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"17:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"23:45\\\\\\"}]}\\",\\n \\"Type\\": 2,\\n \\"ConcurrentRate\\": 10,\\n \\"NumRepeated\\": 0,\\n \\"OutboundNums\\": [\\n \\"150****0000\\"\\n ],\\n \\"RecallRule\\": {\\n \\"Count\\": 2,\\n \\"Interval\\": 2\\n },\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"ForecastCallRate\\": 1.2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Get Outbound Job Details ', + 'description' => 'The outbound call job details include the job ID, job status, task type, outbound caller number, callee number repetition policy, and other information. For more information, see [Response parameters](#api-detail-40). '."\n" + ."\n" + .'### Queries per second (QPS) limits '."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API invocation frequency: 100 times per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. '."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskDetail'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAgentResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</DeleteAgentResponse>","errorExample":""}]', - 'title' => 'DeleteAgent', + 'ramActions' => [], ], - 'UpdateAgent' => [ - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAiOutboundTaskExecDetail' => [ + 'summary' => 'Obtain task execution details by instance ID and job ID. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'BatchVersion', + 'in' => 'query', + 'schema' => ['description' => 'The job batch version.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'SkillGroupId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '2345****', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => 'The outbound phone number.', 'example' => '150****000', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'SkillGroupIdList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '2321****,4567****', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The operation is invalid.', - 'errorCode' => 'InvalidOperation', - ], - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'name' => 'CaseStatus', + 'in' => 'query', + 'schema' => ['description' => 'Job execution status for a single phone number. Valid values:'."\n" + ."\n" + .'- **1**: Pending call.'."\n" + .'- **2**: Calling.'."\n" + .'- **3**: Completed.'."\n" + .'- **4**: Stopped.'."\n" + .'- **5**: Pending retry.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAgentResponse>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Code>Success</Code>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n</UpdateAgentResponse>","errorExample":""}]', - 'title' => 'UpdateAgent', - ], - 'GetAgent' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CreateTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'Start time of phone number import. Format: UNIX timestamp in milliseconds.', 'example' => '1632289999000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'BearerToken' => [], + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'End time of phone number import. Format: UNIX timestamp in milliseconds.', 'example' => '1632290119000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'js sdk中自动生成的鉴权token', - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'InstanceId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default Value: **20**.', 'example' => '1', 'format' => 'int32', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'AccountName', + 'name' => 'CaseId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Activity ID associated with this outbound call.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'List of task executions. ', 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TenantId' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'GroupList' => [ - 'description' => '', + 'PageSize' => ['description' => 'Page size. ', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CurrentPage' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TotalResults' => ['description' => 'Total number of jobs. ', 'example' => '199', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'List' => [ + 'description' => 'List of outbound call executions. ', 'items' => [ - 'description' => '', + 'description' => 'Details of an outbound call. ', 'properties' => [ - 'Description' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'DisplayName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'SkillGroupId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Name' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], + 'Status' => ['description' => 'Execution status. Valid values:'."\n" + ."\n" + .'- **1**: Pending call.'."\n" + .'- **2**: Calling.'."\n" + .'- **3**: Completed.'."\n" + .'- **4**: Stopped.'."\n" + .'- **5**: Pending retry.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'StatusDesc' => ['description' => 'Execution status description.', 'example' => '待呼叫', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'BizData' => ['description' => 'Custom business information', 'example' => '123', 'title' => '', 'type' => 'string'], + 'BatchVersion' => ['description' => 'Job batch.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PhoneNum' => ['description' => 'Outbound phone number.', 'example' => '150****0000', 'title' => '', 'type' => 'string'], + 'LastCallResult' => ['description' => 'Result of the last outbound call.', 'example' => '未接通', 'title' => '', 'type' => 'string'], + 'CreateTime' => ['description' => 'Number import time. UNIX timestamp format, unit: milliseconds.', 'example' => '1632289999000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'CaseId' => ['description' => 'The activity ID associated with this outbound call.', 'example' => '123456', 'format' => 'int64', 'title' => 'id', 'type' => 'integer'], + 'CallCount' => ['description' => 'The number of outbound calls.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'title' => '', 'type' => 'array', - ], - 'DisplayName' => [ - 'description' => '', 'example' => '', - 'type' => 'string', - ], - 'AgentId' => [ - 'description' => '', - 'example' => '222222', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AccountName' => [ - 'description' => '', - 'example' => '123@123.com', - 'type' => 'string', ], + 'HasNextPage' => ['description' => 'Indicates whether a next page exists.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => '', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"StatusDesc\\": 0,\\n \\"BizData\\": \\"123\\",\\n \\"BatchVersion\\": 1,\\n \\"PhoneNum\\": \\"150****0000\\",\\n \\"LastCallResult\\": \\"未接通\\",\\n \\"CreateTime\\": 1632289999000,\\n \\"CaseId\\": 123456,\\n \\"CallCount\\": 1\\n }\\n ],\\n \\"HasNextPage\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Get Job Execution Details', + 'description' => 'The task execution details include the total number of jobs, job batches, outbound call numbers, corresponding call counts, execution status, and other information.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second.'."\n" + .'- API invocation frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskExecDetail'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"GroupList\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 1,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DisplayName\\": \\"XX测试\\",\\n \\"AgentId\\": 222222,\\n \\"AccountName\\": \\"username@example.com\\"\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAgentResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <Status>0</Status>\\n <DisplayName>刘测试</DisplayName>\\n <AgentId>222222</AgentId>\\n <GroupList>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>1</ChannelType>\\n <SkillGroupId>123456</SkillGroupId>\\n <Name>自动化技能组</Name>\\n </GroupList>\\n <AccountName>123@123.com</AccountName>\\n <TenantId>0</TenantId>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetAgentResponse>","errorExample":""}]', - 'title' => 'GetAgent', + 'ramActions' => [], ], - 'ListAgentBySkillGroupId' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAiOutboundTaskList' => [ + 'summary' => 'Retrieve the outbound call job list by instance ID and Task Type.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_****', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'InstanceId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Task Type. Valid values:'."\n" + ."\n" + .'- **2**: Predictive outbound call.'."\n" + .'- **3**: Automated outbound call.'."\n", 'example' => '2', 'format' => 'int32', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'CreateTimeStart', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '666666', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The start time for job creation. The value is a UNIX timestamp in milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TenantId' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DisplayName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'AgentId' => [ - 'description' => '', - 'example' => '666666', - 'format' => 'int64', - 'type' => 'integer', - ], - 'AccountName' => [ - 'description' => '', - 'example' => 'username@example.com', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'type' => 'object', - ], + [ + 'name' => 'CreateTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The end time for job creation. The value is a UNIX timestamp in milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Job status. Valid values:'."\n" + ."\n" + .'- **0**: Not started.'."\n" + .'- **1**: In progress.'."\n" + .'- **2**: Paused by the system.'."\n" + .'- **3**: Manually paused.'."\n" + .'- **4**: Completed.'."\n" + .'- **5**: Stopped.'."\n", 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 666666,\\n \\"AccountName\\": \\"username@example.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListAgentBySkillGroupIdResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <Status>0</Status>\\n <DisplayName>刘测试</DisplayName>\\n <AgentId>666666</AgentId>\\n <AccountName>username@example.com</AccountName>\\n <TenantId>0</TenantId>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</ListAgentBySkillGroupIdResponse>","errorExample":""}]', - 'title' => 'ListAgentBySkillGroupId', - ], - 'GetHotlineAgentStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number to query.', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'SearchKey', + 'in' => 'query', + 'schema' => ['description' => 'Filter condition.'."\n" + ."\n" + .'> Matches job ID or performs fuzzy matching on job name.', 'example' => '1763****', 'required' => false, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Job list.', + 'properties' => [ + 'PageSize' => ['description' => 'Page size.', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CurrentPage' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TotalResults' => ['description' => 'Total number of data entries.', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'List' => [ + 'description' => 'Job information.', + 'items' => [ + 'description' => 'Job information.', + 'properties' => [ + 'Status' => ['description' => 'Task Status. Valid values:'."\n" + ."\n" + .'- **0**: Not started.'."\n" + .'- **1**: In progress.'."\n" + .'- **2**: System paused.'."\n" + .'- **3**: Manually paused.'."\n" + .'- **4**: Completed.'."\n" + .'- **5**: Stopped.', 'example' => '0', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'FinishRate' => ['description' => 'Job completion rate.', 'example' => '0.7', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'StatusDesc' => ['description' => 'Task status description.', 'example' => '未开始', 'title' => '', 'type' => 'string'], + 'HandlerId' => ['description' => 'Skill group ID (for predictive dialing) or IVR ID (for auto dialing).', 'example' => '2468****', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'ConcurrentRate' => ['description' => 'Concurrent outbound calls.'."\n" + ."\n" + .'> Parameter specific to auto dialing.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TotalCount' => ['description' => 'Total number of jobs.', 'example' => '100', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TaskId' => ['description' => 'Job ID.', 'example' => '1763****', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Description' => ['description' => 'Job description.', 'example' => '房产销售', 'title' => '', 'type' => 'string'], + 'CreateTime' => ['description' => 'The deadline for job creation. UNIX timestamp format, in milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'FinishCount' => ['description' => 'The number of completed tasks.', 'example' => '70', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'HandlerName' => ['description' => 'Skill group name or IVR name.', 'example' => '热线技能组', 'title' => '', 'type' => 'string'], + 'Name' => ['description' => 'Job name.', 'example' => 'xxxx外呼任务', 'title' => '', 'type' => 'string'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'HasNextPage' => ['description' => 'Indicates whether there is a next page. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.'."\n", 'example' => 'false', 'title' => '', 'type' => 'boolean'], + ], + 'title' => '', + 'type' => 'object', 'example' => '', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', ], + 'Code' => ['description' => 'Status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"FinishRate\\": 0.7,\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"HandlerId\\": 0,\\n \\"ConcurrentRate\\": 1,\\n \\"TotalCount\\": 100,\\n \\"TaskId\\": 0,\\n \\"Description\\": \\"房产销售\\",\\n \\"CreateTime\\": 1615083365000,\\n \\"FinishCount\\": 70,\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"Name\\": \\"xxxx外呼任务\\"\\n }\\n ],\\n \\"HasNextPage\\": false\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain the Outbound Call Job List', + 'description' => '- The job list contains job information, including job ID, Task Status, Task Name, task completion rate, and more. For details, see [Response parameters](#api-detail-40).'."\n" + .'- If you need to update job information, you can invoke the [UpdateAiOutboundTask](~~2718021~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second.'."\n" + .'- API invocation frequency: 100 times/second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskList'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"通话中\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineAgentStatusResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>通话中</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetHotlineAgentStatusResponse>","errorExample":""}]', - 'title' => 'GetHotlineAgentStatus', + 'ramActions' => [], ], - 'RemoveAgentFromSkillGroup' => [ - 'summary' => '从技能组中移除坐席', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAiOutboundTaskProgress' => [ + 'summary' => 'Obtain the outbound call job progress by instance ID and job ID. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'SkillGroupId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1146****', - 'format' => 'int64', - 'required' => true, - 'title' => '技能组id', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'AgentIds', + 'name' => 'BatchVersion', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '["6083****","6084****"]', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], - 'required' => true, - 'title' => '坐席列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Job batch.'."\n" + ."\n" + .'> If empty, queries all data under the job.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -9134,616 +6064,460 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'ok', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Job progress. ', 'properties' => [ - 'SuccessCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '成功移除的坐席数', - 'type' => 'integer', + 'Type' => ['description' => 'Task Type. Valid values: '."\n" + .'- **2**: Predictive. '."\n" + .'- **3**: Automatic. ', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TaskId' => ['description' => 'The job ID. ', 'example' => '123456', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'CalloutProgress' => [ + 'description' => 'Progress by outbound call dimension. ', + 'properties' => [ + 'CallOutCount' => ['description' => 'Number of outbound calls. ', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallOutConnectCount' => ['description' => 'Number of successful outbound call connections. '."\n" + .'> This parameter is specific to automatic outbound calls.', 'example' => '5', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallOutUserPickupCount' => ['description' => 'Customer Pickup Count. '."\n" + .'> A parameter exclusive to predictive outbound calls.', 'example' => '5', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallOutUserPickupRate' => ['description' => 'Customer Pickup Rate. '."\n" + .'> A parameter exclusive to predictive outbound calls.', 'example' => '0.5', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'CallLossRate' => ['description' => 'Call Loss Rate. '."\n" + .'> A parameter exclusive to predictive outbound calls.', 'example' => '0.01', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'CallOutConnectRate' => ['description' => 'Outbound Call Connection Rate. '."\n" + .'> A parameter exclusive to automated outbound calls.', 'example' => '0.5', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'CallOutServicerPickupCount' => ['description' => 'Agent Pickup Count. '."\n" + .'> A parameter exclusive to predictive outbound calls.', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallLossCount' => ['description' => 'Call loss count. '."\n" + .'> A parameter specific to predictive outbound calls. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallOutServicerPickupRate' => ['description' => 'Agent pickup rate. '."\n" + .'> A parameter specific to predictive outbound calls. ', 'example' => '0.4', 'format' => 'float', 'title' => '', 'type' => 'number'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', + ], + 'TaskProgress' => [ + 'description' => 'Job dimension progress. ', + 'properties' => [ + 'FinishRate' => ['description' => 'Job completion rate. ', 'example' => '0.20', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'ConnectRate' => ['description' => 'Job connection rate. '."\n" + .'> A parameter specific to automatic outbound calls. ', 'example' => '0.2', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'WaitingCallCount' => ['description' => 'Number of pending call jobs. ', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'FinishCount' => ['description' => 'Number of completed jobs.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ConnectCount' => ['description' => 'Number of connected jobs.'."\n" + ."\n" + .'> Parameter specific to auto dialing.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TotalCount' => ['description' => 'Total number of jobs.', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'WaitingRecallCount' => ['description' => 'Number of jobs pending redial.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'TerminateCount' => ['description' => 'Number of stopped jobs.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ServicerPickupCount' => ['description' => 'Number of agent pickups.'."\n" + ."\n" + .'> Parameter specific to predictive dialing.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'UserPickupCount' => ['description' => 'Number of customer pickups.'."\n" + ."\n" + .'> Parameter specific to predictive dialing.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CallingCount' => ['description' => 'Number of jobs in calling status.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ServicerPickupRate' => ['description' => 'Agent pickup rate.'."\n" + ."\n" + .'> Exclusive parameter for predictive outbound calls.', 'example' => '0.2', 'format' => 'float', 'title' => '', 'type' => 'number'], + 'UserPickupRate' => ['description' => 'Customer pickup rate.'."\n" + ."\n" + .'> Exclusive parameter for predictive outbound calls.', 'example' => '0.2', 'format' => 'float', 'title' => '', 'type' => 'number'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], - 'title' => '结果信息', + 'title' => '', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code.', 'example' => 'ok', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Type\\": 2,\\n \\"TaskId\\": 123456,\\n \\"CalloutProgress\\": {\\n \\"CallOutCount\\": 10,\\n \\"CallOutConnectCount\\": 5,\\n \\"CallOutUserPickupCount\\": 5,\\n \\"CallOutUserPickupRate\\": 0.5,\\n \\"CallLossRate\\": 0.01,\\n \\"CallOutConnectRate\\": 0.5,\\n \\"CallOutServicerPickupCount\\": 4,\\n \\"CallLossCount\\": 1,\\n \\"CallOutServicerPickupRate\\": 0.4\\n },\\n \\"TaskProgress\\": {\\n \\"FinishRate\\": 0.2,\\n \\"ConnectRate\\": 0.2,\\n \\"WaitingCallCount\\": 2,\\n \\"FinishCount\\": 2,\\n \\"ConnectCount\\": 2,\\n \\"TotalCount\\": 10,\\n \\"WaitingRecallCount\\": 2,\\n \\"TerminateCount\\": 2,\\n \\"ServicerPickupCount\\": 2,\\n \\"UserPickupCount\\": 2,\\n \\"CallingCount\\": 2,\\n \\"ServicerPickupRate\\": 0.2,\\n \\"UserPickupRate\\": 0.2\\n }\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Get outbound job progress', + 'description' => '- Before invoking this API, we recommend that you confirm the instance ID and job ID. For more information, see [Request Parameters](#api-detail-35). '."\n" + .'- The outbound call job progress includes information such as job ID, Task Type, job completion rate, agent connection rate, and customer connection rate. For details, see [Response Parameters](#api-detail-40). '."\n" + ."\n" + .'### Queries per second (QPS) limits '."\n" + .'- Per-user invocation frequency: 100 times/second. '."\n" + .'- API-wide invocation frequency: 100 times/second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskProgress'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveAgentFromSkillGroupResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <Data>\\n <SuccessCount>2</SuccessCount>\\n </Data>\\n</RemoveAgentFromSkillGroupResponse>","errorExample":""}]', - 'title' => 'RemoveAgentFromSkillGroup', + 'ramActions' => [], ], - 'GetHotlineAgentDetail' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAllDepartment' => [ + 'summary' => 'getAllDepartment', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d****', - 'required' => false, - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Returned data. ', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], 'Data' => [ - 'description' => '', - 'properties' => [ - 'Assigned' => [ - 'description' => '', - 'example' => 'false', - 'type' => 'boolean', - ], - 'TenantId' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RestType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'AgentStatus' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'AgentStatusCode' => [ - 'description' => '', - 'example' => 'AgentCheckout', - 'type' => 'string', - ], - 'Token' => [ - 'description' => '', - 'example' => 'dnthF_oinHg7JMJDmKqex3Ux****', - 'type' => 'string', - ], - 'AgentId' => [ - 'description' => '', - 'example' => '2235****', - 'format' => 'int64', - 'type' => 'integer', + 'description' => 'Department information. ', + 'items' => [ + 'description' => 'Department information. ', + 'properties' => [ + 'DepartmentName' => ['description' => 'Department name. ', 'example' => '部门A', 'type' => 'string', 'title' => ''], + 'DepartmentId' => ['description' => 'Department ID. ', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => 'data', + 'type' => 'array', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 10\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain all department information', + 'description' => '- You can invoke this API to obtain department IDs for department group queries in certain data query APIs (such as [GetHotlineServiceStatistics](~~2717938~~)). '."\n" + .'- After creating, deleting, or updating department information, you can invoke this API to confirm whether the department information matches your expectations.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second. '."\n" + .'- API invocation frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Assigned\\": false,\\n \\"TenantId\\": 0,\\n \\"RestType\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"AgentStatusCode\\": \\"AgentCheckout\\",\\n \\"Token\\": \\"dnthF_oinHg7JMJDmKqex3Ux****\\",\\n \\"AgentId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineAgentDetailResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <AgentStatusCode>AgentCheckout</AgentStatusCode>\\n <Token>dnthF_oinHg7JMJDmKqex3Ux****</Token>\\n <Assigned>false</Assigned>\\n <RestType>1</RestType>\\n <AgentStatus>1</AgentStatus>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetHotlineAgentDetailResponse>","errorExample":""}]', - 'title' => 'GetHotlineAgentDetail', - ], - 'CreateSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllDepartment'], + ], ], + 'ramActions' => [], + ], + 'GetAudioNoteUploadUrl' => [ + 'summary' => 'Retrieves the upload address for a voice memo recording.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsACHORA'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'SkillGroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ChannelType', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '2', - 'format' => 'int32', - 'maximum' => '7', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-****-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the file to upload.', 'type' => 'string', 'required' => true, 'example' => 'test-audio', 'title' => ''], ], [ - 'name' => 'DepartmentId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => false, - 'title' => '部门ID', - 'type' => 'integer', - ], + 'name' => 'FileType', + 'in' => 'query', + 'schema' => ['description' => 'The file type.', 'type' => 'string', 'required' => false, 'example' => 'wav', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access is denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The status code description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'FilePath' => ['description' => 'The storage path of the OSS file.', 'type' => 'string', 'example' => 'audio/file/sample1', 'title' => ''], + 'Policy' => ['description' => 'The upload policy.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'SecurityToken' => ['description' => 'The authorization licensing key.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'Expire' => ['description' => 'The expiration time of the authorization.', 'type' => 'string', 'example' => '2026-06-13T12:19:13Z', 'title' => ''], + 'UploadUrl' => ['description' => 'The upload URL.', 'type' => 'string', 'example' => '//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com', 'title' => ''], + 'MaxFileSize' => ['description' => 'The maximum file size.', 'type' => 'integer', 'format' => 'int64', 'example' => '2560000', 'title' => ''], + 'AccessKeyId' => ['description' => 'The AccessKey ID used for signing.', 'type' => 'string', 'example' => 'STS.NYMxfDw3GkXfvEmZHXXXXXX', 'title' => ''], + 'Signature' => ['description' => 'The signature of the temporary upload credential, used to verify legitimacy during upload.', 'type' => 'string', 'example' => 'oss sig text', 'title' => ''], + 'Host' => ['description' => 'The host address.', 'type' => 'string', 'example' => '//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com', 'title' => ''], + 'Method' => ['description' => 'The HTTP method used for upload.', 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'Key' => ['description' => 'The key of the OSS file.', 'type' => 'string', 'example' => 'audio/file/sample1', 'title' => ''], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - 'errorCode' => 'InvalidInstanceId', - ], - [ - 'errorMessage' => 'The specified department is unavailable or does not exist.', - 'errorCode' => 'Department.NotFound', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve voice memo OSS upload information', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateSkillGroupResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>123456</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</CreateSkillGroupResponse>","errorExample":""}]', - 'title' => 'CreateSkillGroup', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"FilePath\\": \\"audio/file/sample1\\",\\n \\"Policy\\": \\"text\\",\\n \\"SecurityToken\\": \\"text\\",\\n \\"Expire\\": \\"2026-06-13T12:19:13Z\\",\\n \\"UploadUrl\\": \\"//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com\\",\\n \\"MaxFileSize\\": 2560000,\\n \\"AccessKeyId\\": \\"STS.NYMxfDw3GkXfvEmZHXXXXXX\\",\\n \\"Signature\\": \\"oss sig text\\",\\n \\"Host\\": \\"//alicom-voice-ai-agent-xxxx.oss-cn-xxxx.aliyuncs.com\\",\\n \\"Method\\": \\"POST\\",\\n \\"Key\\": \\"audio/file/sample1\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'UpdateSkillGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetCallDialogContent' => [ + 'summary' => 'Retrieves the dialog content for a call by using its call ID. You can retrieve content for calls completed within the last 30 days.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '275547', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], - ], - [ - 'name' => 'SkillGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Description', + 'name' => 'CallDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The outbound call date, in yyyy-MM-dd format. You can only query data from the last 30 days.', 'type' => 'string', 'required' => false, 'example' => '2025-06-06', 'title' => ''], ], [ - 'name' => 'DisplayName', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique identifier for a call.'."\n" + ."\n" + .'> The LlmSmartCall API returns this ID in the CallId parameter of its response.', 'type' => 'string', 'required' => false, 'example' => '123456^123478', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'AccessDeniedDetail' => ['description' => 'Details about the access denial. Returned only when RAM authentication fails.', 'type' => 'string', 'example' => 'Access Denied', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'DialogContent' => ['description' => 'The dialog content.', 'type' => 'string', 'example' => '[{\\"content\\":\\"您好。\\",\\"role\\":\\"assistant\\"},{\\"content\\":\\"不用了。\\",\\"role\\":\\"user\\"},{\\"content\\":\\"呃，不用了，再见，谢谢。\\",\\"role\\":\\"user\\"}]', 'title' => ''], + 'CallId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '123456^123478'."\n", 'title' => ''], + 'CallStatus' => ['description' => 'The call status.'."\n" + ."\n" + .'> Valid values:'."\n" + .'>'."\n" + .'> - `0`: Not connected'."\n" + .'>'."\n" + .'> - `1`: Connected'."\n" + .'>'."\n" + .'> - `2`: Disconnected', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - 'errorCode' => 'InvalidInstanceId', - ], + ['errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', 'description' => 'The parameter CallId is invalid.'."\n"], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"RequestId\\": \\"FB0B0481-F13E-16E0-8A7A-1AD2FXXXEF55\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"DialogContent\\": \\"[{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"您好。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"assistant\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"不用了。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"呃，不用了，再见，谢谢。\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"role\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"user\\\\\\\\\\\\\\"}]\\",\\n \\"CallId\\": \\"123456^123478\\\\n\\",\\n \\"CallStatus\\": 2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query conversation content of calls that ended within the past month by CallId', + 'changeSet' => [ + ['createdAt' => '2026-01-09T03:56:48.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-01-09T03:56:35.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateSkillGroupResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</UpdateSkillGroupResponse>","errorExample":""}]', - 'title' => 'UpdateSkillGroup', - ], - 'RemoveSkillGroup' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:GetCallDialogContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetCallSoundRecord' => [ + 'summary' => 'Obtain the URL of a call recording file based on the call creation time and the unique call ID, and then retrieve the call recording file using the URL.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'SkillGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CreateTime', + 'in' => 'query', + 'schema' => ['description' => 'Call creation time. Format: YYYY-MM-DD hh:mm:ss.'."\n" + ."\n\n" + .'You can invoke the [RobotCall](~~2717996~~) API and check the **date** parameter in the **Response Header** to obtain this value.', 'example' => '2021-10-15 08:56:23', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'Unique call ID.'."\n" + ."\n\n" + .'You can invoke the [RobotCall](~~2717996~~) API and check the **Data** field in the response parameters to obtain this value.', 'example' => '125165515022^11195613****', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'URL of the call recording file.', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - 'errorCode' => 'InvalidInstanceId', - ], + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Call Recording File', + 'description' => '### Prerequisites'."\n" + .'Before invoking this API, ensure that call recording was enabled during the invocation of the [RobotCall](~~223270~~) API and that you successfully received the recording receipt, indicating that the recording file has been generated. Otherwise, an invalid URL will be returned.'."\n" + ."\n" + .'### How-To'."\n" + .'This API serves as a supplementary method to the recording receipt. If the URL in the recording receipt message expires, you can use this API to obtain a new recording URL. By default, the validity period of the recording receipt URL is three days.'."\n" + ."\n" + .'> We recommend that you directly download the recording content using the recording receipt URL and save it locally, rather than relying on the receipt URL, to avoid issues caused by expiration.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> Throttling will be triggered if the total invocations from multiple users exceed the API frequency limit.', + 'changeSet' => [ + ['createdAt' => '2021-10-21T13:04:17.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<RemoveSkillGroupResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</RemoveSkillGroupResponse>","errorExample":""}]', - 'title' => 'RemoveSkillGroup', - ], - 'QuerySkillGroups' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:GetCallSoundRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetConfigNumList' => [ + 'summary' => 'Invoke the GetConfigNumList API to obtain the hotline settings number list.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9751,336 +6525,146 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ChannelType', + 'name' => 'DepartmentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => false, - 'title' => '技能组类型（1：热线，2：在线，4：工单）', - 'type' => 'integer', - 'enum' => [ - '1', - '2', - '4', - ], - ], + 'schema' => ['description' => 'The department ID.', 'example' => '12345', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'DepartmentId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1023****', - 'format' => 'int64', - 'required' => false, - 'title' => '部门ID', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The agent account name. It is unique within the instance (logon name).', 'example' => '123@123.com', 'required' => false, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'OnePageSize' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TotalPage' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'type' => 'integer', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '76', - 'format' => 'int32', - 'type' => 'integer', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'SkillGroupName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'DisplayName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'SkillGroupId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelType' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], + 'description' => 'The number list.', + 'items' => ['description' => 'The number list.', 'example' => '0:"057****890" 1:"057****506" 2:"057****507" 3:"057****417" 4:"057****090" 5:"057****888"', 'type' => 'string', 'title' => ''], + 'title' => '', 'type' => 'array', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The specified instance is unavailable or does not exist.', - 'errorCode' => 'InvalidInstanceId', - ], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified department does not exist.', 'errorCode' => 'Department.NotFound', 'description' => ''], + ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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 \\"Description\\": \\"自动化技能组\\",\\n \\"SkillGroupName\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<QuerySkillGroupsResponse>\\n<OnePageSize>20</OnePageSize>\\n<TotalPage>4</TotalPage>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<CurrentPage>1</CurrentPage>\\n<TotalResults>76</TotalResults>\\n<Data>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>2</ChannelType>\\n <SkillGroupName>自动化技能组</SkillGroupName>\\n <SkillGroupId>123456</SkillGroupId>\\n</Data>\\n</QuerySkillGroupsResponse>","errorExample":""}]', - 'title' => 'QuerySkillGroups', - ], - 'ListSkillGroup' => [ - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n \\"0:\\\\\\"057****890\\\\\\" 1:\\\\\\"057****506\\\\\\" 2:\\\\\\"057****507\\\\\\" 3:\\\\\\"057****417\\\\\\" 4:\\\\\\"057****090\\\\\\" 5:\\\\\\"057****888\\\\\\"\\"\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain the hotline settings number list', + 'changeSet' => [ + ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfigNumList'], + ], ], + 'ramActions' => [], + ], + 'GetCustomerInfo' => [ + 'summary' => 'You can invoke the GetCustomerInfo API to obtain membership details by Workbench membership ID.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ChannelType', + 'name' => 'MemberId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'maximum' => '7', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Membership ID. ', 'example' => '82345678****', 'exclusiveMaximum' => true, 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'DF6A3FB7-A5AA-43BE-A65B', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Description' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'DisplayName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'SkillGroupId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelType' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Name' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', + 'description' => 'Membership information.', + 'properties' => [ + 'OuterId' => ['description' => 'External ID.', 'example' => '6666666', 'title' => '', 'type' => 'string'], + 'Nick' => ['description' => 'Nickname.', 'example' => '测试会员', 'title' => '', 'type' => 'string'], + 'UserId' => ['description' => 'Membership ID.', 'example' => '823456789023', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'CustomizeFields' => ['description' => 'Custom fields.', 'title' => '', 'type' => 'object', 'example' => ''], + 'Photo' => ['description' => 'Profile picture.', 'example' => 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ', 'title' => '', 'type' => 'string'], + 'RealName' => ['description' => 'Real name.', 'example' => '刘测试', 'title' => '', 'type' => 'string'], ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"OuterId\\": \\"6666666\\",\\n \\"Nick\\": \\"测试会员\\",\\n \\"UserId\\": 823456789023,\\n \\"CustomizeFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Photo\\": \\"https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ\\",\\n \\"RealName\\": \\"刘测试\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve membership information ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerInfo'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListSkillGroupResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <DisplayName>自动化技能组</DisplayName>\\n <Description>自动化技能组</Description>\\n <ChannelType>2</ChannelType>\\n <SkillGroupId>123456</SkillGroupId>\\n <Name>自动化技能组</Name>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</ListSkillGroupResponse>","errorExample":""}]', - 'title' => 'ListSkillGroup', + 'ramActions' => [], ], 'GetDepGroupTreeData' => [ - 'summary' => '获取技能组分组', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries skill group categories and the skill group list by AICCS instance ID and agent ID.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10088,36 +6672,19 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '租户实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '坐席ID', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The agent ID.'."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and view the **AgentId** parameter in the response to obtain the agent ID.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -10125,106 +6692,82 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'Message', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'title' => 'Message', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Department information.', 'items' => [ - 'description' => '', + 'description' => 'Department information.', 'properties' => [ - 'DepGroupId' => [ - 'description' => '', - 'example' => '10', - 'title' => 'depGroupId', - 'type' => 'string', - ], + 'DepGroupId' => ['description' => 'The department ID.', 'example' => '10****', 'title' => 'depGroupId', 'type' => 'string'], 'GroupDTOS' => [ - 'description' => '', + 'description' => 'Skill group data.', 'items' => [ - 'description' => '', + 'description' => 'Skill group information.', 'properties' => [ - 'SkillGroupId' => [ - 'description' => '', - 'example' => '555555', - 'format' => 'int64', - 'title' => 'skillGroupId', - 'type' => 'integer', - ], - 'Name' => [ - 'description' => '', - 'example' => '', - 'title' => 'name', - 'type' => 'string', - ], + 'SkillGroupId' => ['description' => 'The skill group ID.', 'example' => '55****', 'format' => 'int64', 'title' => 'skillGroupId', 'type' => 'integer'], + 'Name' => ['description' => 'The name of the skill group.', 'example' => '自动化技能组', 'title' => 'name', 'type' => 'string'], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], 'title' => 'groupDTOS', 'type' => 'array', - ], - 'DepGroupName' => [ - 'description' => '', 'example' => '', - 'title' => 'depGroupName', - 'type' => 'string', ], + 'DepGroupName' => ['description' => 'The department name.', 'example' => '部门A', 'title' => 'depGroupName', 'type' => 'string'], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], 'title' => 'Data', 'type' => 'array', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => 'Code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'Success', - 'type' => 'string', - ], + 'Code' => ['description' => 'The status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'title' => 'Code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => 'Success', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"DepGroupId\\": \\"10****\\",\\n \\"GroupDTOS\\": [\\n {\\n \\"SkillGroupId\\": 0,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DepGroupName\\": \\"部门A\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetDepGroupTreeDataResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>xxxx</Message>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <Data>\\n <DepGroupName>部门A</DepGroupName>\\n <DepGroupId>10</DepGroupId>\\n <GroupDTOS>\\n <SkillGroupId>555555</SkillGroupId>\\n <Name>自动化技能组</Name>\\n </GroupDTOS>\\n </Data>\\n</GetDepGroupTreeDataResponse>","errorExample":""}]', - 'title' => 'GetDepGroupTreeData', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"DepGroupId\\": \\"10****\\",\\n \\"GroupDTOS\\": [\\n {\\n \\"SkillGroupId\\": 0,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"DepGroupName\\": \\"部门A\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Query the list of skill groups and their groupings', + 'description' => '- The skill groups returned by this API are grouped by department ID, which can be specified when you [create a skill group](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup).'."\n" + .'- To query detailed skill group information, you can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API.'."\n" + .'- Before invoking this API, you should confirm the AICCS instance ID and agent ID. For guidance on how to obtain them, see the description of [Request Parameters](#api-detail-35).'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 1000 queries per second.'."\n" + .'- API-wide invocation frequency: 1000 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-13T16:12:41.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepGroupTreeData'], + ], + ], + 'ramActions' => [], ], - 'CreateDepartment' => [ - 'summary' => '创建部门信息', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDepartmentalLatitudeAgentStatus' => [ + 'summary' => 'Obtain department-level status metrics under hotline monitoring. Supports queries by instance, time range, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10232,219 +6775,239 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'DepartmentName', + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** in the response parameters to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', 'example' => '', - 'required' => true, - 'title' => '部门名称', - 'type' => 'string', ], ], + [ + 'name' => 'ExistDepartmentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to query by department grouping. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Status code description. ', 'example' => 'message', 'title' => '', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Data list. ', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of pages. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'The information is a JSON string of type List<Map>.', 'example' => '{"tenant_id":905,"n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"department_id":-1,"department_name":-1,"n_resttype98_now":0,"n_online_now":0,"date_id":20210329,"n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}', 'title' => '', 'type' => 'string'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], - 'title' => 'Schema of Response', + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateDepartmentResponse>\\n <RequestId>98B032F5-6473-4EAC-8BA8-C28993513A1F</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>123456</Data>\\n</CreateDepartmentResponse>","errorExample":""}]', - 'title' => 'CreateDepartment', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"message\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":905,\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"department_id\\\\\\":-1,\\\\\\"department_name\\\\\\":-1,\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":20210329,\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain department-level status metrics under hotline monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second. '."\n" + .'- API-wide invocation frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter description for the returned parameter Rows:'."\n" + ."\n" + .' n_idle_now: Current number of idle agents '."\n" + .' n_resttype_now: Current number of agents on short breaks '."\n" + .' n_resttype1_now: Current number of agents on regular short breaks '."\n" + .' n_resttype2_now: Current number of agents on meal breaks '."\n" + .' n_resttype3_now: Current number of agents in meetings '."\n" + .' n_resttype4_now: Current number of agents receiving coaching '."\n" + .' n_resttype5_now: Current number of agents in training '."\n" + .' n_resttype98_now: Current number of agents on forced breaks '."\n" + .' n_resttype99_now: Current number of agents signed in but on break '."\n" + .' n_ack_now: Current number of agents in post-processing '."\n" + .' n_online_now: Current number of online agents '."\n" + .' n_busy_now: Current number of agents on calls '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' date_id: Date '."\n" + .' n_inqueue_now: Current number of members in queue '."\n" + .' n_inservice_now: Current number of members in service '."\n" + .' time_value: UNIX timestamp '."\n" + .' fst_assign_time: Earliest assignment time in this queue, indicating when queued members were assigned'."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepartmentalLatitudeAgentStatus'], + ], + ], + 'ramActions' => [], ], - 'GetAllDepartment' => [ - 'summary' => 'getAllDepartment', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineAgentDetail' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it by using a UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox specified during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'DepartmentName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'DepartmentId' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - ], - 'type' => 'object', + 'description' => 'Agent service data. ', + 'properties' => [ + 'Assigned' => ['description' => 'Indicates whether the agent is assigned. Valid values: '."\n" + .'**false**: Not assigned (no call). '."\n" + .'**true**: Assigned (in a call). ', 'example' => 'false', 'type' => 'boolean', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID to which the agent belongs, corresponding to the instance ID in the input parameter. ', 'example' => 'ccc_xp_pre-cn-***', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'RestType' => ['description' => 'Break type. Valid values: '."\n" + .'- **1**: Short break. '."\n" + .'- **2**: Meal break. '."\n" + .'- **3**: Meeting. '."\n" + .'- **4**: Coaching. '."\n" + .'- **5**: Training. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'AgentStatus' => ['description' => 'Agent status. Valid values: **1~6**. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'AgentStatusCode' => ['description' => 'Agent status code. Valid values: '."\n" + .'- **AgentCheckout**: Agent logged off. '."\n" + .'- **AgentReady**: Agent idle. '."\n" + .'- **AgentBreak**: Agent on break. '."\n" + .'- **AgentAcw**: Post-processing after a call. '."\n" + .'- **AgentBusyForCall**: In a call. ', 'example' => 'AgentCheckout', 'type' => 'string', 'title' => ''], + 'Token' => ['description' => 'Heartbeat signature. ', 'example' => 'dnthF_oinHg7JMJDmKqex3Ux****', 'type' => 'string', 'title' => ''], + 'AgentId' => ['description' => 'Agent ID. ', 'example' => '2235****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], ], - 'title' => 'data', - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'result', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 10\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAllDepartmentResponse>\\n <Message>successful</Message>\\n <RequestId>98B032F5-6473-4EAC-8BA8-C28993513A1F</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <DepartmentId>10</DepartmentId>\\n <DepartmentName>部门A</DepartmentName>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetAllDepartmentResponse>","errorExample":""}]', - 'title' => 'GetAllDepartment', + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Assigned\\": false,\\n \\"TenantId\\": 0,\\n \\"RestType\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"AgentStatusCode\\": \\"AgentCheckout\\",\\n \\"Token\\": \\"dnthF_oinHg7JMJDmKqex3Ux****\\",\\n \\"AgentId\\": 0\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Hotline Agent Details', + 'summary' => 'Obtain the current service details of a hotline agent based on the instance ID and agent account name. ', + 'description' => 'The hotline agent details include information such as agent posture status, agent ID, and heartbeat signature. For more information, see [Response parameters](#api-detail-40). '."\n" + ."\n" + .'### Queries per second (QPS) limit '."\n" + .'- Per-user invocation frequency: Rate Limiting is not applied. '."\n" + .'- API frequency: 100 queries per second (QPS). '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. '."\n", + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'DeleteDepartment' => [ - 'summary' => '删除部门信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineAgentDetailReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10452,226 +7015,240 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.', 'docRequired' => true, 'example' => '1', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'The UNIX timestamp of the start date. Unit: milliseconds.', 'docRequired' => true, 'example' => '1614824872', 'format' => 'int64', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'The UNIX timestamp of the end date. Unit: milliseconds.', 'docRequired' => true, 'example' => '1614824972', 'format' => 'int64', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', + 'description' => 'The list of department IDs.', + 'items' => ['description' => 'The department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](~~2717975~~) API and view the **DepartmentId** in the response to obtain the department ID.'."\n" + ."\n" + .'> If this parameter is not empty:'."\n" + .'> - If GroupIds is not empty, the query is performed based on the skill group list specified by GroupIds.'."\n" + .'> - If GroupIds is empty, the query is performed based on the department list specified by this parameter.', 'example' => '5623***', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DepartmentId', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '部门id', - 'type' => 'integer', + 'description' => 'The list of skill group IDs.', + 'items' => ['description' => 'The skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](~~2717970~~) API and view the **SkillGroupId** in the response to obtain the skill group ID.'."\n" + ."\n" + .'> If this parameter is not empty, the query is performed based on the specified skill group list.', 'example' => '1232****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'seccessful', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Query result data.', + 'properties' => [ + 'PageSize' => ['description' => 'Number of records per page.', 'example' => '10', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Total' => ['description' => 'Total number of records.', 'example' => '7', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Columns' => [ + 'description' => 'Description of returned columns.', + 'items' => [ + 'description' => 'Metric data.', + 'properties' => [ + 'Title' => ['description' => 'Metric description.', 'example' => '客服姓名', 'type' => 'string', 'title' => ''], + 'Key' => ['description' => 'Metric.', 'example' => 'realName', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Page' => ['description' => 'Current page.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Rows' => [ + 'description' => 'The returned data result.', + 'items' => ['description' => 'The returned data.', 'example' => '[{"hotline_time_acw_incall":"2.56","hotline_time_acw_outcall":"5.78","hotline_time_outcall_avg":"14.89","hotline_num_incall_answer":12,"servicerId":36****,"hotline_time_login":"1s","hotline_rate_handle_in_60s":"100.00%","hotline_time_agent_idle":"1s","hotline_time_agent_rest":"1s","servicerName":"testAccount","hotline_time_incall_avg":"1.23","hotline_num_to_rest_cnt":4,"call_out_cnt":10,"call_out_intervene_cnt":3,"call_out_all_len":"1s","call_out_ring_len":"1s","call_out_intervene_len":"1s","evaluate_rate":"0.00%"}]', 'type' => 'object', 'title' => ''], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'string', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'The specified department does not exist.', - 'errorCode' => 'Department.NotFound', - ], - ], 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Message\\": \\"seccessful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteDepartmentResponse>\\n <RequestId>98B032F5-6473-4EAC-8BA8-C28993513A1F</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>seccessful</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n</DeleteDepartmentResponse>","errorExample":""}]', - 'title' => 'DeleteDepartment', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 7,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"客服姓名\\",\\n \\"Key\\": \\"realName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain Hotline Agent Dimension (T+1) Data Details', + 'summary' => 'Obtain detailed data metrics by hotline agent dimension (T+1). Supports grouping queries by instance, time range, department, and skill group.', + 'description' => '- Before invoking this API, ensure that you have [activated the service](~~276009~~) and [created an instance](~~276011~~).'."\n" + .'- If you need to specify department or skill group information, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'> Query logic priority:'."\n" + .'> - If GroupIds is not empty, query data metrics under the specified skill groups.'."\n" + .'> - Otherwise, if DepIds is not empty, query data metrics under the corresponding department groups.'."\n" + .'> - Otherwise, query data metrics under the AICCS instance.'."\n" + ."\n" + .'### QPS Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 10 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'UpdateDepartment' => [ - 'summary' => '更新部门信息', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineAgentStatus' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], - ], - [ - 'name' => 'DepartmentName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => true, - 'title' => '部门名称', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'DepartmentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '部门id', - 'type' => 'integer', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance. ', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Agent status. Valid values: '."\n" + .'- **Offline** '."\n" + .'- **Idle** '."\n" + .'- **Post-processing** '."\n" + .'- **In Call** '."\n" + .'- **Break - Rest** '."\n" + .'- **Break - Meal** '."\n" + .'- **Break - Meeting** '."\n" + .'- **Break - Training** '."\n" + .'- **Break - Coaching** ', 'example' => '通话中', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded. ', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateDepartmentResponse>\\n <RequestId>98B032F5-6473-4EAC-8BA8-C28993513A1</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>true</Data>\\n</UpdateDepartmentResponse>","errorExample":""}]', - 'title' => 'UpdateDepartment', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"通话中\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Hotline Agent Status ', + 'summary' => 'Queries the hotline agent status in the Cloud Customer Service System by AICCS instance ID and agent account name. ', + 'description' => '- Before invoking this API, confirm the AICCS instance information and the agent account name. For guidance on how to obtain these details, see the description in [Request Parameters](#api-detail-35). '."\n" + .'- To retrieve detailed information about a hotline agent, you can invoke the [GetHotlineAgentDetail](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-gethotlineagentdetail) API. '."\n" + ."\n" + .'### Queries per second (QPS) Limit '."\n" + .'- Per-user invocation frequency: No rate limiting. '."\n" + .'- API-wide frequency: 200 queries per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GenerateWebSocketSign' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineCallAction' => [ + 'summary' => 'Invoke the GetHotlineCallAction API to query the result data of call actions. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10680,877 +7257,378 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it by using a UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d9****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox specified during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Act', + 'in' => 'formData', + 'schema' => ['description' => 'Operation Type. Valid values:'."\n" + .'- **1**: Hotline.'."\n" + .'- **2**: Online.'."\n" + .'- **3**: Ticket.', 'docRequired' => true, 'example' => '1', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '0', 'required' => false, 'type' => 'integer', 'default' => '0', 'title' => ''], + ], + [ + 'name' => 'FromSource', + 'in' => 'formData', + 'schema' => ['description' => 'Source type. Valid values:'."\n" + ."\n" + .'- **hotlinebs_out**: Hotline.'."\n" + .'- **ticket_out**: Ticket.'."\n" + .'- **other_system_out**: Other system.', 'docRequired' => true, 'example' => 'hotlinebs_out', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Biz', + 'in' => 'formData', + 'schema' => ['description' => 'Business Custom Parameter in JSON format.', 'docRequired' => true, 'example' => '{"name":123}', 'required' => false, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'Acc', + 'in' => 'formData', + 'schema' => ['description' => 'Hotline Custom Parameter in JSON format.', 'example' => '{"time":1}', 'required' => false, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => ' '."\n" + .'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE339D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => 'dnthF_oinHg7JMJDmKqex3UxDD7', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Returned data. ', + 'properties' => [ + 'TaskId' => ['description' => 'Job ID. ', 'example' => '12345****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'SubTouchId' => ['description' => 'Sub-touch ID. ', 'example' => '3423****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'MemberList' => ['description' => 'Membership List. ', 'example' => '8900****', 'type' => 'string', 'title' => ''], + 'DepId' => ['description' => 'Department ID. ', 'example' => '1223****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CaseId' => ['description' => 'Ticket ID. ', 'example' => '1138902****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelId' => ['description' => 'Channel ID. ', 'example' => '2377****', 'type' => 'string', 'title' => ''], + 'TouchId' => ['description' => 'Touch ID. ', 'example' => '2235****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'BuId' => ['description' => 'Tenant ID. ', 'example' => '2367****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CalloutId' => ['description' => 'Callout ID. ', 'example' => '1122****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'MemberId' => ['description' => 'Membership ID. ', 'example' => '7856876****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ActionId' => ['description' => 'Customer ID.', 'example' => '8999****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ServicerName' => ['description' => 'Agent name.', 'example' => 'XX测试', 'type' => 'string', 'title' => ''], + 'CalloutName' => ['description' => 'Call name.', 'example' => '王XX', 'type' => 'string', 'title' => ''], + 'IsTransfer' => ['description' => 'Indicates whether the call is transferred.', 'example' => 'true', 'type' => 'string', 'title' => ''], + 'MemberName' => ['description' => 'Membership name.', 'example' => '匿名会员', 'type' => 'string', 'title' => ''], + 'ServicerId' => ['description' => 'Agent ID.', 'example' => '1332****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelType' => ['description' => 'Channel Type. Valid values:'."\n" + ."\n" + .'- **1**: Hotline.'."\n" + .'- **2**: Online.', 'example' => '2', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"dnthF_oinHg7JMJDmKqex3UxDD7\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GenerateWebSocketSignResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>dnthF_oinHg7JMJDmKqex3UxDD7</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GenerateWebSocketSignResponse>","errorExample":""}]', - 'title' => 'GenerateWebSocketSign', - ], - 'HotlineSessionQuery' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"SubTouchId\\": 0,\\n \\"MemberList\\": \\"8900****\\",\\n \\"DepId\\": 0,\\n \\"CaseId\\": 0,\\n \\"ChannelId\\": \\"2377****\\",\\n \\"TouchId\\": 0,\\n \\"BuId\\": 0,\\n \\"CalloutId\\": 0,\\n \\"MemberId\\": 0,\\n \\"ActionId\\": 0,\\n \\"ServicerName\\": \\"XX测试\\",\\n \\"CalloutName\\": \\"王XX\\",\\n \\"IsTransfer\\": \\"true\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Call Action Result Data', + 'description' => '### Queries per second (QPS) limits '."\n" + .'- Per-user invocation frequency: 50 times/second. '."\n" + .'- API invocation frequency: 100 times/second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [ + ['createdAt' => '2022-03-07T06:25:25.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineCallAction'], + ], ], + 'ramActions' => [], + ], + 'GetHotlineGroupDetailReport' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Acid', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => false, - 'example' => '7719786****', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'CallType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'CalledNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '135615****', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'CallingNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '057177****', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'GroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'MemberId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '7856****', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'MemberName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'QueryEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '161482972', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'QueryStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '161482872', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'RequestId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ServicerName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ServicerId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '555555', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Params', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xxxx', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '50', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'minimum' => '1', 'example' => '20', 'default' => '10', 'title' => ''], ], [ - 'name' => 'CallResult', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'normal', - 'required' => false, - 'type' => 'string', - 'enum' => [ - 'normal', - 'queueClose', - 'dailingClose', - 'ivrClose', - ], - ], + 'schema' => ['description' => 'Start date as a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824872', 'default' => '', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'acc1c58dab4a4dd280e3813c66', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'End date as a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1614824972', 'title' => ''], ], [ - 'name' => 'AcidList', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'CallTypeList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 5, - 'required' => false, - 'type' => 'array', - ], - ], - [ - 'name' => 'GroupIdList', + 'name' => 'DepIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, + 'description' => 'List of department IDs.', 'type' => 'array', - ], - ], - [ - 'name' => 'CallingNumberList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0571773****', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, + 'items' => ['description' => 'Department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](~~2717975~~) API and view the **DepartmentId** in the response to obtain the department ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '56****', 'title' => ''], 'required' => false, - 'type' => 'array', - ], - ], - [ - 'name' => 'CalledNumberList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '135615****', - 'required' => false, - 'type' => 'string', - ], 'maxItems' => 200, - 'required' => false, - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'MemberIdList', + 'name' => 'GroupIds', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '7856876', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, - 'required' => false, + 'description' => 'List of skill group IDs.', 'type' => 'array', - ], - ], - [ - 'name' => 'ServicerIdList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '555555', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](~~2717970~~) API and view the **SkillGroupId** in the response to obtain the skill group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12****', 'title' => ''], 'required' => false, - 'type' => 'array', - ], - ], - [ - 'name' => 'CallResultList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => 'normal', - 'required' => false, - 'type' => 'string', - ], 'maxItems' => 200, - 'required' => false, - 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Returned data.'."\n", + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE339D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.'."\n", 'type' => 'string', 'example' => 'successful', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.'."\n", 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Query result data.'."\n", + 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'example' => '26', - 'format' => 'int32', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'type' => 'integer', - ], - 'PageNumber' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'CallDetailRecord' => [ - 'description' => '', + 'PageSize' => ['description' => 'Number of records per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'Total number of records.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'Columns' => [ + 'description' => 'Description of returned columns.'."\n", + 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'Description of a returned column.'."\n", + 'type' => 'object', 'properties' => [ - 'GroupName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'CallResult' => [ - 'description' => '', - 'example' => 'normal', - 'type' => 'string', - ], - 'CalledNumber' => [ - 'description' => '', - 'example' => '135615*****', - 'type' => 'string', - ], - 'Acid' => [ - 'description' => '', - 'example' => '7719786', - 'type' => 'string', - ], - 'CallType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'QueueUpContinueTime' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'type' => 'integer', - ], - 'PassiveTransferId' => [ - 'description' => '', - 'example' => '12', - 'type' => 'string', - ], - 'CallingNumber' => [ - 'description' => '', - 'example' => '0571773', - 'type' => 'string', - ], - 'MemberId' => [ - 'description' => '', - 'example' => '7856876', - 'type' => 'string', - ], - 'ServicerName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'OutQueueTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:32:59', - 'type' => 'string', - ], - 'RingEndTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:33:09', - 'type' => 'string', - ], - 'PickUpTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:33:09', - 'type' => 'string', - ], - 'EvaluationLevel' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'type' => 'integer', - ], - 'RingContinueTime' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'type' => 'integer', - ], - 'PassiveTransferIdType' => [ - 'description' => '', - 'example' => '1', - 'type' => 'string', - ], - 'EvaluationScore' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'type' => 'integer', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:32:55', - 'type' => 'string', - ], - 'HangUpTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:33:46', - 'type' => 'string', - ], - 'GroupId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'InQueueTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:32:55', - 'type' => 'string', - ], - 'RingStartTime' => [ - 'description' => '', - 'example' => '2020-10-02 22:32:59', - 'type' => 'string', - ], - 'CallContinueTime' => [ - 'description' => '', - 'example' => '37', - 'format' => 'int32', - 'type' => 'integer', - ], - 'ActiveTransferId' => [ - 'description' => '', - 'example' => '12', - 'type' => 'string', - ], - 'HangUpRole' => [ - 'description' => '', - 'example' => '2', - 'type' => 'string', - ], - 'MemberName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => 'acc1c58dab4a4dd280e3813c66', - 'type' => 'string', - ], - 'ServicerId' => [ - 'description' => '', - 'example' => '555555', - 'type' => 'string', - ], - 'TrunkCall' => [ - 'description' => '', - 'example' => '1861111****', - 'type' => 'string', - ], + 'Title' => ['description' => 'Metric description.'."\n", 'type' => 'string', 'example' => '技能组名称', 'title' => ''], + 'Key' => ['description' => 'Metric.'."\n", 'type' => 'string', 'example' => 'skillGroupName', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'Page' => ['description' => 'Current page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Rows' => [ + 'description' => 'Returned data results.'."\n", 'type' => 'array', + 'items' => ['description' => 'Returned data results.', 'type' => 'object', 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'Public', 'title' => ''], ], - 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 26,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"CallDetailRecord\\": [\\n {\\n \\"GroupName\\": \\"自动化技能组\\",\\n \\"CallResult\\": \\"normal\\",\\n \\"CalledNumber\\": \\"135615*****\\",\\n \\"Acid\\": \\"7719786\\",\\n \\"CallType\\": 1,\\n \\"QueueUpContinueTime\\": 4,\\n \\"PassiveTransferId\\": \\"12\\",\\n \\"CallingNumber\\": \\"0571773\\",\\n \\"MemberId\\": \\"7856876\\",\\n \\"ServicerName\\": \\"刘测试\\",\\n \\"OutQueueTime\\": \\"2020-10-02 22:32:59\\",\\n \\"RingEndTime\\": \\"2020-10-02 22:33:09\\",\\n \\"PickUpTime\\": \\"2020-10-02 22:33:09\\",\\n \\"EvaluationLevel\\": 4,\\n \\"RingContinueTime\\": 10,\\n \\"PassiveTransferIdType\\": \\"1\\",\\n \\"EvaluationScore\\": 4,\\n \\"CreateTime\\": \\"2020-10-02 22:32:55\\",\\n \\"HangUpTime\\": \\"2020-10-02 22:33:46\\",\\n \\"GroupId\\": 123456,\\n \\"InQueueTime\\": \\"2020-10-02 22:32:55\\",\\n \\"RingStartTime\\": \\"2020-10-02 22:32:59\\",\\n \\"CallContinueTime\\": 37,\\n \\"ActiveTransferId\\": \\"12\\",\\n \\"HangUpRole\\": \\"2\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"Id\\": \\"acc1c58dab4a4dd280e3813c66\\",\\n \\"ServicerId\\": \\"555555\\",\\n \\"TrunkCall\\": \\"1861111****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<HotlineSessionQueryResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <CallDetailRecord>\\n <CallResult>normal</CallResult>\\n <TrunkCall>1861111****</TrunkCall>\\n <ServicerName>刘测试</ServicerName>\\n <OutQueueTime>2020-10-02 22:32:59</OutQueueTime>\\n <CallContinueTime>37</CallContinueTime>\\n <CreateTime>2020-10-02 22:32:55</CreateTime>\\n <PickUpTime>2020-10-02 22:33:09</PickUpTime>\\n <RingContinueTime>10</RingContinueTime>\\n <CalledNumber>135615*****</CalledNumber>\\n <ServicerId>555555</ServicerId>\\n <HangUpTime>2020-10-02 22:33:46</HangUpTime>\\n <EvaluationLevel>4</EvaluationLevel>\\n <PassiveTransferId>12</PassiveTransferId>\\n <ActiveTransferId>12</ActiveTransferId>\\n <HangUpRole>2</HangUpRole>\\n <PassiveTransferIdType>1</PassiveTransferIdType>\\n <MemberName>匿名会员</MemberName>\\n <EvaluationScore>4</EvaluationScore>\\n <Acid>7719786</Acid>\\n <RingStartTime>2020-10-02 22:32:59</RingStartTime>\\n <CallType>1</CallType>\\n <GroupName>自动化技能组</GroupName>\\n <GroupId>123456</GroupId>\\n <RingEndTime>2020-10-02 22:33:09</RingEndTime>\\n <CallingNumber>0571773</CallingNumber>\\n <InQueueTime>2020-10-02 22:32:55</InQueueTime>\\n <MemberId>7856876</MemberId>\\n <Id>acc1c58dab4a4dd280e3813c66</Id>\\n <QueueUpContinueTime>4</QueueUpContinueTime>\\n </CallDetailRecord>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <TotalCount>26</TotalCount>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</HotlineSessionQueryResponse>","errorExample":""}]', - 'title' => 'HotlineSessionQuery', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 9,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"技能组名称\\",\\n \\"Key\\": \\"skillGroupName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"online_40s_transfer_ready_cnt\\": 81,\\n \\"minute_id\\": \\"-1\\",\\n \\"online_unsatis_cnt\\": 0,\\n \\"online_simple_cnt\\": 0,\\n \\"average_queue_time\\": -1,\\n \\"service_pickup\\": \\"2086\\",\\n \\"total_waiting_time\\": \\"981\\",\\n \\"online_service_time_len\\": 58208,\\n \\"online_direct_give_up_len\\": 0,\\n \\"break_ratio\\": \\"2%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"Public\\"\\n}","type":"json"}]', + 'title' => 'Obtain T+1 Data Details by Hotline Skill Group Dimension', + 'summary' => 'Retrieve detailed (T+1) data by hotline skill group dimension. Supports grouping by instance, time range, department, and skill group.'."\n", + 'description' => '- Before invoking this API, ensure that you have [activated the service](~~276009~~) and [created an instance](~~276011~~). '."\n" + .'- If you need to specify agent, department, or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No Rate Limiting. '."\n" + .'- API frequency: 10 queries per second.'."\n" + ."\n" + .'> Throttle will be triggered if the total invocations from multiple users exceed the API frequency limit.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetRecordData' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineMessageLog' => [ + 'summary' => 'Invoke the GetHotlineMessageLog API to retrieve hotline message records. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1001067****', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Session ID. ', 'example' => '100****2077', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Rusult', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'properties' => [ - 'Acid' => [ - 'description' => '', - 'example' => '1001067****', - 'type' => 'string', - ], - 'OssLink' => [ - 'description' => '', - 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', - 'type' => 'string', + 'description' => 'Voice messages. ', + 'items' => [ + 'description' => 'Voice message. ', + 'properties' => [ + 'Acid' => ['description' => 'The session ID. ', 'example' => '100****2077', 'title' => '', 'type' => 'string'], + 'EndTime' => ['description' => 'The end time. ', 'example' => '1623738027480', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Content' => ['description' => 'The session content. ', 'example' => '您好。', 'title' => '', 'type' => 'string'], + 'SenderType' => ['description' => 'The sender type. Valid values: '."\n" + .'- **1**: Membership '."\n" + .'- **2**: Agent ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'StartTime' => ['description' => 'The start time. ', 'example' => '1623738026460', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Mid' => ['description' => 'The record ID.', 'example' => '11deca999****', 'title' => '', 'type' => 'string'], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded. ', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetRecordDataResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <OssLink>http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***</OssLink>\\n <Acid>1001067****</Acid>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetRecordDataResponse>","errorExample":""}]', - 'title' => 'GetRecordData', - ], - 'GetRecordUrl' => [ - 'summary' => '获取录音链接', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n {\\n \\"Acid\\": \\"100****2077\\",\\n \\"EndTime\\": 1623738027480,\\n \\"Content\\": \\"您好。\\",\\n \\"SenderType\\": 1,\\n \\"StartTime\\": 1623738026460,\\n \\"Mid\\": \\"11deca999****\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve Hotline Message Records ', + 'changeSet' => [ + ['createdAt' => '2021-04-25T12:05:56.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineMessageLog'], + ], ], + 'ramActions' => [], + ], + 'GetHotlineRuntimeInfo' => [ + 'summary' => 'Invoke the GetHotlineRuntimeInfo API to query hotline runtime information. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-****', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Acid', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1001067****', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The instance ID. '."\n" + ."\n" + .'You can log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview) and view the instance ID in **Instance Management**. ', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'RecordType', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'DUP_CALL', - 'required' => true, - 'type' => 'string', - 'enum' => [ - 'DUP_CALL', - 'IVR_CALL', - 'SMART_CALL', - ], - ], + 'schema' => ['description' => 'The agent account name. It is unique within the instance (logon name). ', 'example' => '123@****.com', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ @@ -11558,61 +7636,40 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'Acid' => [ - 'description' => '', - 'example' => '1001067****', - 'title' => '会话id', - 'type' => 'string', - ], - 'OssLink' => [ - 'description' => '', - 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', - 'title' => '录音链接', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'title' => '', 'type' => 'string'], + 'Data' => ['description' => 'Hotline runtime information. ', 'example' => '{"buId":905,"phoneToken":"roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIw****=","isNeedWorkShift":false,"servicerId":741018,"accConfigUrl":"pre-acc-cs-public.alibaba-inc.com","agentBasicCode":"AgentCheckout","startWorkToReady":true,"servicerDn":"2000000001904123","isMaster":"1","tenantId":2001,"depId":1139139,"accTenantId":2001,"phoneData":"{\\"timeStamp\\":164240****,\\"expireTime\\":164257****,\\"dn\\":\\"200000000190****\\",\\"source\\":\\"xspace\\",\\"serviceId\\":741018}","agentBasicDesc":"坐席签出状态"}', 'title' => '', 'type' => 'object'], + 'Code' => ['description' => 'The status code. A return value of "Success" indicates that the request succeeded. ', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetRecordUrlResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Message>OK</Message>\\n <Data>\\n <Acid>1001067****</Acid>\\n <OssLink>http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***</OssLink>\\n </Data>\\n</GetRecordUrlResponse>","errorExample":""}]', - 'title' => 'GetRecordUrl', - ], - 'DescribeRecordData' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"buId\\": 905,\\n \\"phoneToken\\": \\"roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIw****=\\",\\n \\"isNeedWorkShift\\": false,\\n \\"servicerId\\": 741018,\\n \\"accConfigUrl\\": \\"pre-acc-cs-public.alibaba-inc.com\\",\\n \\"agentBasicCode\\": \\"AgentCheckout\\",\\n \\"startWorkToReady\\": true,\\n \\"servicerDn\\": \\"2000000001904123\\",\\n \\"isMaster\\": \\"1\\",\\n \\"tenantId\\": 2001,\\n \\"depId\\": 1139139,\\n \\"accTenantId\\": 2001,\\n \\"phoneData\\": \\"{\\\\\\"timeStamp\\\\\\":164240****,\\\\\\"expireTime\\\\\\":164257****,\\\\\\"dn\\\\\\":\\\\\\"200000000190****\\\\\\",\\\\\\"source\\\\\\":\\\\\\"xspace\\\\\\",\\\\\\"serviceId\\\\\\":741018}\\",\\n \\"agentBasicDesc\\": \\"坐席签出状态\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Hotline Runtime Information ', + 'changeSet' => [ + ['createdAt' => '2021-04-08T02:35:54.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineRuntimeInfo'], + ], ], + 'ramActions' => [], + ], + 'GetHotlineServiceStatistics' => [ + 'summary' => 'Obtain service statistics under hotline monitoring. Supports grouped queries by instance, time dimension, agent, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11620,246 +7677,258 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '15566', - 'abilityTreeNodes' => [ - 'FEATUREaiccsA3JJUR', - ], - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['title' => '', 'description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'type' => 'string', 'required' => true, 'example' => 'ccc_xp_pre-cn-***'], ], [ - 'name' => 'AccountType', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'BUC_TYPE', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1615083365000'], ], [ - 'name' => 'AccountId', + 'name' => 'EndDate', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'End Datetime Variable as a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617761765000'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Current page. The value must be greater than **0**. Default value: **1**.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'AgentIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '2235****', + 'title' => '', + 'description' => 'List of agent IDs.', + 'type' => 'array', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response to obtain the agent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'required' => false, - 'type' => 'string', + 'example' => '', ], ], [ - 'name' => 'Acid', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1004849****', + 'title' => '', + 'description' => 'List of department IDs.', + 'type' => 'array', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], 'required' => false, - 'type' => 'string', + 'example' => '', ], ], [ - 'name' => 'SecLevel', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', + 'title' => '', + 'description' => 'List of skill group IDs.', + 'type' => 'array', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'example' => '', ], ], + [ + 'name' => 'TimeLatitudeType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Time latitude type for grouped queries. Valid values: '."\n" + .'- **minute**: minute '."\n" + .'- **hour**: hour', 'type' => 'string', 'required' => false, 'example' => 'minute'], + ], + [ + 'name' => 'ExistAgentGrouping', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query by agent group. Valid values: '."\n" + .'- **true**: Yes '."\n" + .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ExistDepartmentGrouping', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query by department group. Valid values: '."\n" + .'- **true**: Yes '."\n" + .'- **false**: No', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ExistSkillGroupGrouping', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Indicates whether to query by skill group grouping. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'Acid' => [ - 'description' => '', - 'example' => '1004849****', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'OssLink' => [ - 'description' => '', - 'example' => 'https://****', - 'type' => 'string', - ], - 'AgentId' => [ - 'description' => '', - 'example' => '1212****', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', + 'RequestId' => ['title' => '', 'description' => 'Request ID. ', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'], + 'Message' => ['title' => '', 'description' => 'Status description. ', 'type' => 'string', 'example' => 'message'], + 'Data' => [ + 'title' => 'data', + 'description' => 'Data list. ', + 'type' => 'object', + 'properties' => [ + 'TotalNum' => ['title' => '', 'description' => 'Total number of records. ', 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'PageNum' => ['title' => '', 'description' => 'Current page number. ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['title' => '', 'description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'], + 'Rows' => ['title' => '', 'description' => 'A JSON string of type List<Map>.', 'type' => 'string', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210401","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}'], + ], + 'example' => '', ], + 'Code' => ['title' => '', 'description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'type' => 'string', 'example' => '200'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true'], ], - 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Acid\\": \\"1004849****\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"OssLink\\": \\"https://****\\",\\n \\"AgentId\\": \\"1212****\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeRecordDataResponse>\\n <Acid>1004849****</Acid>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <OssLink>https://****</OssLink>\\n <AgentId>1212****</AgentId>\\n <Code>200</Code>\\n</DescribeRecordDataResponse>","errorExample":""}]', - 'title' => 'DescribeRecordData', + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain service statistics under hotline monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to provide agent, department, or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned parameter Rows:'."\n" + ."\n" + .' n_idle_now: Current number of idle agents '."\n" + .' n_resttype_now: Current number of agents on break '."\n" + .' n_resttype1_now: Current number of agents on regular break '."\n" + .' n_resttype2_now: Current number of agents on meal break '."\n" + .' n_resttype3_now: Current number of agents on meeting break '."\n" + .' n_resttype4_now: Current number of agents on coaching break '."\n" + .' n_resttype5_now: Current number of agents on training break '."\n" + .' n_resttype98_now: Current number of agents on forced break '."\n" + .' n_resttype99_now: Current number of agents signed in but on break '."\n" + .' n_ack_now: Current number of agents in post-processing '."\n" + .' n_online_now: Current number of online agents '."\n" + .' n_busy_now: Current number of agents on calls '."\n" + .' group_name: Skill group name '."\n" + .' group_id: Skill group ID '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' date_id: Date '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineServiceStatistics'], + ], + ], + 'ramActions' => [], ], - 'GetIndexCurrentValue' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetHotlineWaitingNumber' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'DepIds', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2332****,2334****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => "\n" + .'Unique customer request ID, used for idempotency validation; can be generated using UUID ', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2323****,2324****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => "\n" + .'AICCS instance ID, visible in the Artificial Intelligence Cloud Call Service console ', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => "\n" + .'Agent account name (agent logon name) ', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => ' '."\n" + .'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '', - 'type' => 'object', - ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Fault description ', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of an error ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Queue length of hotline members ', 'example' => '2', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Error encoding ', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => "\n" + .'Whether the API call succeeded ', 'example' => 'true', 'type' => 'string', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'View the queue length of hotline calls in the skill group to which the current agent belongs ', + 'summary' => 'Obtain the queue length of hotline members. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n [\\n {\\n \\"indexName\\": \\"hotlineRateRateSati\\",\\n \\"canAcc\\": \\"true\\",\\n \\"indexValue\\": \\"100%\\",\\n \\"indexNameShow\\": \\"hotlineRateRateSati\\",\\n \\"desc\\": \\"热线即时满意度（当天收到的满意评价数 / 参评数）\\"\\n }\\n ]\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetIndexCurrentValueResponse>\\n<RequestId>09CD5EE1-F54D-4777-9CC5-6C171B7C7E46</RequestId>\\n<Message>successful</Message>\\n<Data>\\n <indexName>hotlineRateRateSati</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>100%</indexValue>\\n <indexNameShow>hotlineRateRateSati</indexNameShow>\\n <desc>热线即时满意度（当天收到的满意评价数 / 参评数）</desc>\\n</Data>\\n<Data>\\n <indexName>hotline_rate_service_level</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>100%</indexValue>\\n <indexNameShow>服务水平</indexNameShow>\\n <desc>服务水平</desc>\\n</Data>\\n<Data>\\n <indexName>punctual</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>100%</indexValue>\\n <indexNameShow>遵时度</indexNameShow>\\n <desc>遵时度</desc>\\n</Data>\\n<Data>\\n <indexName>n_incall</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_incall</indexNameShow>\\n <desc>客户电话请求量（包含被接起和未接起）</desc>\\n</Data>\\n<Data>\\n <indexName>n_normal_answer</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_normal_answer</indexNameShow>\\n <desc>客户电话请求中被客服接起的量</desc>\\n</Data>\\n<Data>\\n <indexName>n_overflow_in</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_overflow_in</indexNameShow>\\n <desc>溢入量</desc>\\n</Data>\\n<Data>\\n <indexName>n_overflow_out</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_overflow_out</indexNameShow>\\n <desc>溢出量</desc>\\n</Data>\\n<Data>\\n <indexName>n_inqueue</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_inqueue</indexNameShow>\\n <desc>当前排队量</desc>\\n</Data>\\n<Data>\\n <indexName>t_inqueue_max</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>t_inqueue_max</indexNameShow>\\n <desc>所有排队电话中，最长的等待时长（单位：秒）</desc>\\n</Data>\\n<Data>\\n <indexName>give_rate</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0.00%</indexValue>\\n <indexNameShow>give_rate</indexNameShow>\\n <desc>（进线量 - 接听量）/ 进线量</desc>\\n</Data>\\n<Data>\\n <indexName>pickup_rate_20s</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0.00%</indexValue>\\n <indexNameShow>pickup_rate_20s</indexNameShow>\\n <desc>20s被接起的电话量 / 进线量</desc>\\n</Data>\\n<Data>\\n <indexName>pickup_rate_60s</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0.00%</indexValue>\\n <indexNameShow>pickup_rate_60s</indexNameShow>\\n <desc>60s被接起的电话量 / 进线量</desc>\\n</Data>\\n<Data>\\n <indexName>n_online_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>2</indexValue>\\n <indexNameShow>n_online_now</indexNameShow>\\n <desc>当前在线的坐席数（包含通话、空闲、小休、后处理）</desc>\\n</Data>\\n<Data>\\n <indexName>n_busy_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_busy_now</indexNameShow>\\n <desc>通话中状态的坐席数（包含入呼、外呼）</desc>\\n</Data>\\n<Data>\\n <indexName>n_idle_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>2</indexValue>\\n <indexNameShow>n_idle_now</indexNameShow>\\n <desc>空闲状态中的坐席数（正常情况下代表该坐席可以接听、外呼电话）</desc>\\n</Data>\\n<Data>\\n <indexName>n_acw_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_acw_now</indexNameShow>\\n <desc>后处理状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype_now</indexNameShow>\\n <desc>小休状态中的坐席数（包含签入小休、普通小休、就餐小休、培训等一切小休状态）</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype1_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype1_now</indexNameShow>\\n <desc>普通小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype2_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype2_now</indexNameShow>\\n <desc>就餐小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype3_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype3_now</indexNameShow>\\n <desc>会议小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype4_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype4_now</indexNameShow>\\n <desc>辅导小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype5_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype5_now</indexNameShow>\\n <desc>培训小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype98_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype98_now</indexNameShow>\\n <desc>系统强制小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype99_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype99_now</indexNameShow>\\n <desc>坐席签入小休状态中的坐席数</desc>\\n</Data>\\n<Data>\\n <indexName>n_resttype97_now</indexName>\\n <canAcc>false</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>n_resttype97_now</indexNameShow>\\n <desc>暂无指标说明</desc>\\n</Data>\\n<Data>\\n <indexName>hotlineNumRateSati</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>hotlineNumRateSati</indexNameShow>\\n <desc>热线即时满意评价数（当天收到的满意评价数）</desc>\\n</Data>\\n<Data>\\n <indexName>hotlineNumRateUnSati</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>hotlineNumRateUnSati</indexNameShow>\\n <desc>热线即时不满意评价数（当天收到的不满意评价数）</desc>\\n</Data>\\n<Data>\\n <indexName>hotlineNumRateNormal</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>hotlineNumRateNormal</indexNameShow>\\n <desc>热线即时一般评价数（当天收到的一般评价数）</desc>\\n</Data>\\n<Data>\\n <indexName>ATT</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>ATT</indexNameShow>\\n <desc>平均入呼通话时长</desc>\\n</Data>\\n<Data>\\n <indexName>ACW</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>10</indexValue>\\n <indexNameShow>ACW</indexNameShow>\\n <desc>平均后处理时长</desc>\\n</Data>\\n<Data>\\n <indexName>INCALL ACW</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>INCALL ACW</indexNameShow>\\n <desc>呼入平均后处理时长</desc>\\n</Data>\\n<Data>\\n <indexName>OUTCALL ACW</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>OUTCALL ACW</indexNameShow>\\n <desc>呼出平均后处理时长</desc>\\n</Data>\\n<Data>\\n <indexName>hotline_rate_value_data</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0.00%</indexValue>\\n <indexNameShow>即时问卷满意度</indexNameShow>\\n</Data>\\n<Data>\\n <indexName>hotline_rate_accumulate_data</indexName>\\n <canAcc>true</canAcc>\\n <indexValue>0</indexValue>\\n <indexNameShow>参评量</indexNameShow>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetIndexCurrentValueResponse>","errorExample":""}]', - 'title' => 'GetIndexCurrentValue', + 'ramActions' => [], ], - 'GetAgentIndexRealTime' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetIndexCurrentValue' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11867,195 +7936,220 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'DepIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'List of department IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can call the [GetAllDepartment](~~2717975~~) API and check the **DepartmentId** field in the response to obtain department IDs.'."\n" + ."\n" + .'> When this parameter is not empty: '."\n" + .'> - If GroupIds is not empty, the system prioritizes querying data metrics for the skill groups specified by GroupIds. '."\n" + .'> - If GroupIds is empty, the system prioritizes querying data metrics for the departments specified by this parameter. ', 'example' => '2332****,2334****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'GroupIds', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'List of skill group IDs. Separate multiple IDs with commas (,).'."\n" + ."\n" + .'You can call the [QuerySkillGroups](~~2717970~~) API and check the **SkillGroupId** field in the response to obtain skill group IDs.'."\n" + ."\n" + .'> When this parameter is not empty, the system prioritizes querying data metrics for the specified skill groups. ', 'example' => '2323****,2324****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n" + ."\n" + .'> The AICCS instance ID is required. ', 'example' => 'ccc_xp_pre-cn-***', 'required' => false, 'type' => 'string', 'title' => ''], ], - [ - 'name' => 'DepIds', - 'in' => 'query', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', + 'description' => 'Returned data. ', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'List of data entries. ', + 'items' => ['description' => 'List of key-value pair data entries. ', 'example' => '[{"indexName":"hotlineRateRateSati","canAcc":"true","indexValue":"100%","indexNameShow":"hotlineRateRateSati","desc":"热线即时满意度（当天收到的满意评价数 / 参评数）"}]', 'type' => 'object', 'title' => ''], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'Status code. A value of 200 indicates that the request succeeded. ', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'required' => false, - 'maxItems' => 200, + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n [\\n {\\n \\"indexName\\": \\"hotlineRateRateSati\\",\\n \\"canAcc\\": \\"true\\",\\n \\"indexValue\\": \\"100%\\",\\n \\"indexNameShow\\": \\"hotlineRateRateSati\\",\\n \\"desc\\": \\"热线即时满意度（当天收到的满意评价数 / 参评数）\\"\\n }\\n ]\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Current Data Statistics Metrics ', + 'summary' => 'You can obtain the current statistical metrics (real-time data) and query them by instance ID, department, or skill group.', + 'description' => '- The current data statistics metrics include cumulative metrics for the day and real-time metrics. '."\n" + .'- If you need to specify department or skill group information, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'> Query logic priority: '."\n" + .'> - If GroupIds is not empty, query the data metrics for the specified skill groups. '."\n" + .'> - Otherwise, if DepIds is not empty, query the data metrics for the specified departments. '."\n" + .'> - Otherwise, query the data metrics for the Artificial Intelligence Cloud Call Service (AICCS) instance.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting. '."\n" + .'- API frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => '### Data Description'."\n" + .'| Field | Type | Description |'."\n" + .'| ------------- |------------ | ----- |'."\n" + .'| indexName | String | Metric code | '."\n" + .'| canAcc | Boolean | is additive (false indicates an instantaneous data metric) | '."\n" + .'| indexValue | String | Metric value | '."\n" + .'| indexShowName | String | Metric display name | '."\n" + .'| desc | String | Metric description | '."\n" + ."\n" + .'### Existing Metrics Description'."\n" + .'| IndexName | IndexShowName |'."\n" + .'| ------------- |------------ | '."\n" + .'| hotlineRateRateSati | Hotline Instant Satisfaction Rate (Number of satisfied evaluations received on the same day / Total number of evaluations) | '."\n" + .'| hotline_rate_service_level | Service Level | '."\n" + .'| punctual | Punctuality Degree | '."\n" + .'| n_incall | Customer Call Request Volume (Includes both answered and unanswered calls) | '."\n" + .'| n_normal_answer | Number of customer call requests answered by agents | '."\n" + .'| n_overflow_in | Overflow-In Volume | '."\n" + .'| n_overflow_out | Overflow-Out Volume | '."\n" + .'| n_inqueue | Current Queue Volume | '."\n" + .'| t_inqueue_max | Maximum waiting time among all queued calls (Unit: seconds) | '."\n" + .'| tgive_rate | (Incoming Calls - Answered Calls) / Incoming Calls | '."\n" + .'| pickup_rate_20s | Number of calls answered within 20 seconds / Incoming Calls | '."\n" + .'| pickup_rate_60s | Number of calls answered within 60 seconds / Incoming Calls | '."\n" + .'| n_online_now | Number of agents currently online (Includes agents in call, idle, break, or post-processing status) | '."\n" + .'| n_busy_now | Number of agents in call status (Includes inbound and outbound calls) | '."\n" + .'| n_idle_now | Number of agents in idle status (Normally indicates the agent is available to take or make calls) | '."\n" + .'| n_acw_now | Number of agents in post-processing status | '."\n" + .'| n_resttype_now | Number of agents in break status (Includes sign-in break, regular break, meal break, training, and all other break types) | '."\n" + .'| n_resttype1_now | Number of agents in regular break status | '."\n" + .'| n_resttype2_now | Number of agents in meal break status | '."\n" + .'| n_resttype3_now | Number of agents in meeting break status | '."\n" + .'| n_resttype4_now | Number of agents in coaching break status | '."\n" + .'| n_resttype5_now | Number of agents in training break status | '."\n" + .'| n_resttype98_now | Number of agents in system-forced break status | '."\n" + .'| n_resttype99_now | Number of agents in sign-in break status | '."\n" + .'| hotlineNumRateSati | Number of Hotline Instant Satisfied Evaluations (Number of satisfied evaluations received on the same day) | '."\n" + .'| hotlineNumRateUnSati | Number of Hotline Instant Dissatisfied Evaluations (Number of dissatisfied evaluations received on the same day) | '."\n" + .'| hotlineNumRateNormal | Number of Hotline Instant Neutral Evaluations (Number of neutral evaluations received on the same day) | '."\n" + .'| ATT | Average Inbound Talk Time | '."\n" + .'| ACW | Average Post-Processing Time | '."\n" + .'| INCALL ACW | Average Inbound Post-Processing Time | '."\n" + .'| OUTCALL ACW | Average Outbound Post-Processing Time | '."\n" + .'| hotline_rate_value_data | Hotline Instant Survey Satisfaction Score | '."\n" + .'| hotline_rate_accumulate_data | Total Number of Evaluations | ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetInstanceList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GroupIds', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], - 'required' => false, - 'maxItems' => 200, - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], - 'Data' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'servicerId', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - ], - ], - ], - 'Page' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rows' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - ], + 'TotalCount' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageNumber' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'CommodityInstances' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 4,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"servicerId\\",\\n \\"Key\\": \\"客服ID\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"TotalCount\\": 0,\\n \\"RequestId\\": \\"\\",\\n \\"Message\\": \\"\\",\\n \\"PageSize\\": 0,\\n \\"PageNumber\\": 0,\\n \\"HttpStatusCode\\": 0,\\n \\"CommodityInstances\\": [\\n {\\n \\"InstanceId\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'GetHotlineAgentDetailReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMcuLvsIp' => [ + 'summary' => 'Invoke the GetMcuLvsIp API to query the hotline server IP address.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12063,229 +8157,117 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Intelligent Cloud Call console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], - [ - 'name' => 'PageSize', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '200', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '10', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => 'error message', 'type' => 'string'], + 'Data' => ['description' => 'IP information. The value is a JSON string of the List type.', 'example' => '{ "xmculvs":[ 0:{ "port":00 "ip":"0.0.0.0" "name":"lvs1" } ]}', 'title' => 'result data', 'type' => 'string'], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => 'error code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"{ \\\\\\"xmculvs\\\\\\":[ 0:{ \\\\\\"port\\\\\\":00 \\\\\\"ip\\\\\\":\\\\\\"0.0.0.0\\\\\\" \\\\\\"name\\\\\\":\\\\\\"lvs1\\\\\\" } ]}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Hotline Server IP Address', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMcuLvsIp'], + ], + ], + 'ramActions' => [], + ], + 'GetNumLocation' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1614824872', - 'format' => 'int64', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], + 'AK' => [], ], [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1614824972', - 'format' => 'int64', - 'minimum' => '1', - 'required' => true, - 'type' => 'integer', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation and can be generated using a UUID.', 'type' => 'string', 'required' => false, 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'title' => ''], ], [ - 'name' => 'DepIds', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '5623***', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'PhoneNum', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1232****', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'schema' => ['description' => 'Phone number to query.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1360987****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Total' => [ - 'description' => '', - 'example' => '7', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Columns' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Title' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Key' => [ - 'description' => '', - 'example' => 'realName', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - 'Page' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Rows' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '[{"hotline_time_acw_incall":"2.56","hotline_time_acw_outcall":"5.78","hotline_time_outcall_avg":"14.89","hotline_num_incall_answer":12,"servicerId":366001,"hotline_time_login":"1s","hotline_rate_handle_in_60s":"100.00%","hotline_time_agent_idle":"1s","hotline_time_agent_rest":"1s","servicerName":"testAccount","hotline_time_incall_avg":"1.23","hotline_num_to_rest_cnt":4,"call_out_cnt":10,"call_out_intervene_cnt":3,"call_out_all_len":"1s","call_out_ring_len":"1s","call_out_intervene_len":"1s","evaluate_rate":"0.00%"}]', - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - ], 'type' => 'object', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => ''], + 'Data' => ['description' => 'Number归属地.', 'type' => 'string', 'example' => '杭州', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 7,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"客服姓名\\",\\n \\"Key\\": \\"realName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineAgentDetailReportResponse>\\n<Message>successful</Message>\\n<RequestId>24D9F55F-064E-48D2-851C-5C6ABC654C9E</RequestId>\\n<Data>\\n <PageSize>2</PageSize>\\n <Total>40</Total>\\n <Columns>\\n <Title>客服名称</Title>\\n <Key>servicerName</Key>\\n </Columns>\\n <Columns>\\n <Title>服务接起量</Title>\\n <Key>hotline_num_incall_answer</Key>\\n </Columns>\\n <Columns>\\n <Title>60s响应率</Title>\\n <Key>hotline_rate_handle_in_60s</Key>\\n </Columns>\\n <Columns>\\n <Title>登录时长</Title>\\n <Key>hotline_time_login</Key>\\n </Columns>\\n <Columns>\\n <Title>入呼平均接听时长</Title>\\n <Key>hotline_time_incall_avg</Key>\\n </Columns>\\n <Columns>\\n <Title>呼入平均后处理时长</Title>\\n <Key>hotline_time_acw_incall</Key>\\n </Columns>\\n <Columns>\\n <Title>小休总时长</Title>\\n <Key>hotline_time_agent_rest</Key>\\n </Columns>\\n <Columns>\\n <Title>小休总次数</Title>\\n <Key>hotline_num_to_rest_cnt</Key>\\n </Columns>\\n <Columns>\\n <Title>空闲总时长</Title>\\n <Key>hotline_time_agent_idle</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼量</Title>\\n <Key>call_out_cnt</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼接通量</Title>\\n <Key>call_out_intervene_cnt</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼总时长</Title>\\n <Key>call_out_all_len</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼振铃总时长</Title>\\n <Key>call_out_ring_len</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼接通总时长</Title>\\n <Key>call_out_intervene_len</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼平均时长</Title>\\n <Key>hotline_time_outcall_avg</Key>\\n </Columns>\\n <Columns>\\n <Title>外呼平均后处理时长</Title>\\n <Key>hotline_time_acw_outcall</Key>\\n </Columns>\\n <Columns>\\n <Title>参评量</Title>\\n <Key>evaluate_cnt</Key>\\n </Columns>\\n <Columns>\\n <Title>参评率</Title>\\n <Key>evaluate_rate</Key>\\n </Columns>\\n <Page>1</Page>\\n <Rows>\\n <hotline_time_acw_incall>2.56</hotline_time_acw_incall>\\n <hotline_time_acw_outcall>5.78</hotline_time_acw_outcall>\\n <hotline_time_outcall_avg>14.89</hotline_time_outcall_avg>\\n <hotline_num_incall_answer>12</hotline_num_incall_answer>\\n <servicerId>366001</servicerId>\\n <hotline_time_login>1s</hotline_time_login>\\n <hotline_rate_handle_in_60s>100.00%</hotline_rate_handle_in_60s>\\n <hotline_time_agent_idle>1s</hotline_time_agent_idle>\\n <hotline_time_agent_rest>1s</hotline_time_agent_rest>\\n <servicerName>testAccount</servicerName>\\n <hotline_time_incall_avg>1.23</hotline_time_incall_avg>\\n <hotline_num_to_rest_cnt>4</hotline_num_to_rest_cnt>\\n <call_out_cnt>10</call_out_cnt>\\n <call_out_intervene_cnt>3</call_out_intervene_cnt>\\n <call_out_all_len>1s</call_out_all_len>\\n <call_out_ring_len>1s</call_out_ring_len>\\n <call_out_intervene_len>1s</call_out_intervene_len>\\n <evaluate_rate>0.00%</evaluate_rate>\\n </Rows>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetHotlineAgentDetailReportResponse>","errorExample":""}]', - 'title' => 'GetHotlineAgentDetailReport', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Number归属地', + 'summary' => 'Obtain the number\'s归属地 information based on the instance ID and phone number.', + 'description' => '### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetHotlineGroupDetailReport' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetOnlineSeatInformation' => [ + 'summary' => 'Obtain online agent information data under real-time monitoring. Support queries by instance, time range, agent, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12293,562 +8275,355 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'PageSize', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'StartDate', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1614824872', - 'default' => '', - ], + 'schema' => ['description' => 'End date UNIX timestamp. Unit: milliseconds. ', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'EndDate', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1614824972', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'InstanceId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.'."\n", 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'DepIds', + 'name' => 'AgentIds', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56****', - ], + 'description' => 'List of agent IDs. ', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and view the **AgentId** in the response parameters to obtain the agent ID. ', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'maxItems' => 200, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'GroupIds', + 'name' => 'DepIds', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12****', - ], + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'maxItems' => 200, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'successful', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'type' => 'object', + 'description' => 'Data list. ', 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'Columns' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Title' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], - 'Key' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'skillGroupName', - ], - ], - ], - ], - 'Page' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Rows' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'example' => '{"online_40s_transfer_ready_cnt":81,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":-1,"service_pickup":"2086","total_waiting_time":"981","online_service_time_len":58208,"online_direct_give_up_len":0,"break_ratio":"2%"}', - ], - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'The information is a JSON string of the List<Map> type.', 'example' => '{"tenant_id":"905","max_service_num":"3","servicer_id":"36****","tenant_name":"非单元测试化BU","record_gmt_modified":"2021-04-01 23:20:03","pk_id":"3690012021****","record_gmt_create":"2021-04-01 23:19:55","department_id":"10****"}', 'title' => '', 'type' => 'string'], ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Public', - ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'title' => '', 'type' => 'string'], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 9,\\n \\"Columns\\": [\\n {\\n \\"Title\\": \\"技能组名称\\",\\n \\"Key\\": \\"skillGroupName\\"\\n }\\n ],\\n \\"Page\\": 1,\\n \\"Rows\\": [\\n {\\n \\"online_40s_transfer_ready_cnt\\": 81,\\n \\"minute_id\\": \\"-1\\",\\n \\"online_unsatis_cnt\\": 0,\\n \\"online_simple_cnt\\": 0,\\n \\"average_queue_time\\": -1,\\n \\"service_pickup\\": \\"2086\\",\\n \\"total_waiting_time\\": \\"981\\",\\n \\"online_service_time_len\\": 58208,\\n \\"online_direct_give_up_len\\": 0,\\n \\"break_ratio\\": \\"2%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"Public\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"max_service_num\\\\\\":\\\\\\"3\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"36****\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"record_gmt_modified\\\\\\":\\\\\\"2021-04-01 23:20:03\\\\\\",\\\\\\"pk_id\\\\\\":\\\\\\"3690012021****\\\\\\",\\\\\\"record_gmt_create\\\\\\":\\\\\\"2021-04-01 23:19:55\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"10****\\\\\\"}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Retrieve Online Agent Information from Real-Time Monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify agent or department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned Rows parameter:'."\n" + ."\n" + .' department_id: Department ID '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' current_service_num: Current service capacity '."\n" + .' max_service_num: Maximum service capacity '."\n" + .' max_speci_ability_num: Whale吞 Plus 1—current maximum usable capacity '."\n" + .' current_speci_ability_num: Whale吞 Plus 1—currently used capacity '."\n" + .' speci_ability_status: Whale吞 Plus 1—current status; n0: assignment paused, n1: assignable '."\n" + .' servicer_status_name: Hotline agent name '."\n" + .' fst_login_time: Earliest logon time of the day '."\n" + .' lst_login_time: Latest logon time of the day '."\n" + .' servicer_rest_cnt: Number of short breaks '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineSeatInformation'], + ], + ], + 'ramActions' => [], ], - 'QueryTouchList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetOnlineServiceVolume' => [ + 'summary' => 'Obtain the volume of Online Services under online monitoring. Support grouped queries by instance, time range, agent, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'TouchId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'ChannelId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '846a7a4aa2524186b899a6ba02****', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'End Datetime UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'ChannelType', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - 'enum' => [ - '1', - '2', - ], - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'TouchType', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - 'enum' => [ - '1', - '2', - ], - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'MemberId', - 'in' => 'formData', - 'style' => 'repeatList', + 'name' => 'AgentIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, + 'description' => 'List of agent IDs.', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and check the **AgentId** field in the response to obtain the agent ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'MemberName', - 'in' => 'formData', - 'style' => 'repeatList', + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => 'zhangsan', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'ServicerId', - 'in' => 'formData', - 'style' => 'repeatList', + 'name' => 'GroupIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '70020', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'ServicerName', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => 'lisi', - 'required' => false, - 'type' => 'string', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'TimeLatitudeType', + 'in' => 'query', + 'schema' => ['description' => 'Time latitude type. Valid values: '."\n" + .'- **minute**: Minute. '."\n" + .'- **hour**: Hour. '."\n" + .'- **day**: Day.', 'example' => 'minute', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'QueueId', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 200, - 'required' => false, - 'type' => 'array', - ], + 'name' => 'ExistAgentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Whether to query by agent grouping. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'EvaluationStatus', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - 'enum' => [ - '-1', - '0', - '1', - ], - ], + 'name' => 'ExistDepartmentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Whether to group by department in the query. Default Value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'EvaluationLevel', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - 'enum' => [ - '2', - '3', - '4', - '5', - ], - ], + 'name' => 'ExistSkillGroupGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether to query by skill group grouping. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], - [ - 'name' => 'EvaluationScore', - 'in' => 'formData', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - 'maxItems' => 10, - 'required' => false, - 'type' => 'array', - 'enum' => [ - '1', - '2', - '3', - '4', - '5', + 'description' => 'Service data.'."\n", + 'properties' => [ + 'Message' => ['description' => 'Status code description.'."\n", 'example' => 'successful', 'title' => '', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Data' => [ + 'description' => 'Data list.'."\n", + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records.', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>.', 'example' => '{"tenant_id":"905","online_40s_transfer_ready_cnt":109,"minute_id":"-1","wait_time_len":1215,"pickup_rate":"63.09%","thirty_seconds_to_pickUp":"2560","date_id":"-1","online_over_out_cnt":0,"online_20s_transfer_ready_cnt":109,"thirty_seconds_response_rate":"63.09%","abandonment_rate":"63.09%","service_time_len":68378,"service_pickup":"2560","hour_id":"-1","online_10s_transfer_ready_cnt":109}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', + ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"online_40s_transfer_ready_cnt\\\\\\":109,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"wait_time_len\\\\\\":1215,\\\\\\"pickup_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"thirty_seconds_to_pickUp\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"date_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_over_out_cnt\\\\\\":0,\\\\\\"online_20s_transfer_ready_cnt\\\\\\":109,\\\\\\"thirty_seconds_response_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"abandonment_rate\\\\\\":\\\\\\"63.09%\\\\\\",\\\\\\"service_time_len\\\\\\":68378,\\\\\\"service_pickup\\\\\\":\\\\\\"2560\\\\\\",\\\\\\"hour_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_10s_transfer_ready_cnt\\\\\\":109}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain the Number of Online Services Under Online Monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify agent, department, or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned parameter Rows:'."\n" + ."\n" + .' online_direct_request_cnt: Direct request count '."\n" + .' online_transfer_request_cnt: Transfer request count (transfer indicates requests transferred to this agent by others) '."\n" + .' online_direct_giveup_cnt: Direct abandonment count '."\n" + .' online_transfer_giveup_cnt: Transfer abandonment count '."\n" + .' online_direct_ready_cnt: Direct answered count '."\n" + .' online_transfer_ready_cnt: Transfer answered count '."\n" + .' online_10s_direct_ready_cnt: Direct answered within 10 seconds count '."\n" + .' online_10s_transfer_ready_cnt: Transfer answered within 10 seconds count '."\n" + .' online_20s_direct_ready_cnt: Direct answered within 20 seconds count '."\n" + .' online_20s_transfer_ready_cnt: Transfer answered within 20 seconds count '."\n" + .' online_30s_direct_ready_cnt: Direct answered within 30 seconds count '."\n" + .' online_30s_transfer_ready_cnt: Transfer answered within 30 seconds count '."\n" + .' online_40s_direct_ready_cnt: Direct answered within 40 seconds count '."\n" + .' online_40s_transfer_ready_cnt: Transfer answered within 40 seconds count '."\n" + .' online_60s_direct_ready_cnt: Direct answered within 60 seconds count '."\n" + .' online_60s_transfer_ready_cnt: Transfer answered within 60 seconds count '."\n" + .' online_over_out_cnt: Skill group overflow count '."\n" + .' online_over_in_cnt: Skill group inflow count '."\n" + .' online_sat_cnt: Satisfied count '."\n" + .' online_normal_cnt: Neutral count '."\n" + .' online_unsat_cnt: Dissatisfied count '."\n" + .' service_time_len: Total service duration '."\n" + .' wait_time_len: Total waiting duration '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineServiceVolume'], + ], + ], + 'ramActions' => [], + ], + 'GetOutbounNumList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FirstTimeStart', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1614596400000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'FirstTimeEnd', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1614599400000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'AK' => [], ], [ - 'name' => 'CloseTimeStart', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1614600400000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'CloseTimeEnd', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1614600500000', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it by using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'maximum' => '500', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '50', - ], + 'schema' => ['description' => "\n" + .'Instance ID.'."\n" + ."\n" + .'You can log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview) and view the instance ID in **Instance Management**.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Agent account name (agent logon name).', 'docRequired' => true, 'example' => '123@****.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -12856,318 +8631,88 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'ResultData' => [ - 'description' => '', + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => [ + 'description' => 'Information about the number list. ', 'properties' => [ - 'Empty' => [ - 'description' => '', - 'example' => 'false', - 'type' => 'boolean', - ], - 'OnePageSize' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TotalPage' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'PreviousPage' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', + 'Num' => [ + 'description' => 'Caller number information. ', 'items' => [ - 'description' => '', + 'description' => 'Caller number information. ', 'properties' => [ - 'ParentTouchId' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'type' => 'integer', - ], - 'DepId' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'GmtModified' => [ - 'description' => '', - 'example' => '1611207979000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'UserTouchId' => [ - 'description' => '', - 'example' => '1386****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CommonQueueName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'ChannelId' => [ - 'description' => '', - 'example' => '4f8807a9de024507a3090b5b66a8****', - 'type' => 'string', - ], - 'TouchId' => [ - 'description' => '', - 'example' => '1386****', - 'type' => 'string', - ], - 'MemberId' => [ - 'description' => '', - 'example' => '6400665****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ServicerName' => [ - 'description' => '', - 'example' => '13900001234', - 'type' => 'string', - ], - 'Feedback' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'TouchType' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Status' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'SwitchUser' => [ - 'description' => '', - 'example' => 'null', - 'type' => 'string', - ], - 'FirstTime' => [ - 'description' => '', - 'example' => '1611209971000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'FromId' => [ - 'description' => '', - 'example' => '6400665****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'QueueId' => [ - 'description' => '', - 'example' => '111', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ExtAttrsString' => [ - 'description' => '', - 'type' => 'object', - ], - 'TouchTime' => [ - 'description' => '', - 'example' => '111', - 'type' => 'string', - ], - 'ToId' => [ - 'description' => '', - 'example' => '678026', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BuId' => [ - 'description' => '', - 'example' => '905', - 'format' => 'int64', - 'type' => 'integer', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '1611209971000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CloseTime' => [ - 'description' => '', - 'example' => '1611207976000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ExtAttrs' => [ - 'description' => '', - 'properties' => [ - 'EvaluationScore' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'OnlineJoinRespInterval' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Dnis' => [ - 'description' => '', - 'example' => '05712688****', - 'type' => 'string', - ], - 'OnlineSessionSource' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', - ], - 'EvaluationStatus' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'EvaluationLevel' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'OutCallRouteNumber' => [ - 'description' => '', - 'example' => '05712688****', - 'type' => 'string', - ], - 'Ani' => [ - 'description' => '', - 'example' => '187****0000', - 'type' => 'string', - ], - 'EvaluationSolution' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], - 'TouchEndReason' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'MemberName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'ServicerId' => [ - 'description' => '', - 'example' => '67****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'TouchContent' => [ - 'description' => '', - 'example' => '1', - 'type' => 'string', - ], + 'Type' => ['description' => 'Caller number type. Valid values: '."\n" + ."\n" + .'- **1**: Number. '."\n" + .'- **2**: Number group. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Description' => ['description' => 'Description of the caller number (geographic location information). ', 'example' => '浙江省杭州市', 'type' => 'string', 'title' => ''], + 'Value' => ['description' => 'Caller number. ', 'example' => '07512234****', 'type' => 'string', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], 'type' => 'array', + 'title' => '', + 'example' => '', ], - 'NextPage' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', + 'NumGroup' => [ + 'description' => 'Number group information. ', + 'items' => [ + 'description' => 'Number group information. ', + 'properties' => [ + 'Type' => ['description' => 'Number group type. Valid values: '."\n" + ."\n" + .'- **1**: Number. '."\n" + .'- **2**: Number group. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Description' => ['description' => 'Number group description (number group name).', 'example' => 'Jella', 'type' => 'string', 'title' => ''], + 'Value' => ['description' => 'Number group ID.', 'example' => '7688****', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => '865658FD-80DE-5D49-ABEB-F3CC9863F4F1', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Num\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"浙江省杭州市\\",\\n \\"Value\\": \\"07512234****\\"\\n }\\n ],\\n \\"NumGroup\\": [\\n {\\n \\"Type\\": 2,\\n \\"Description\\": \\"Jella\\",\\n \\"Value\\": \\"7688****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain the outbound number list', + 'summary' => 'Retrieve the list of external hotline numbers. ', + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"Empty\\": false,\\n \\"OnePageSize\\": 2,\\n \\"TotalPage\\": 4,\\n \\"CurrentPage\\": 1,\\n \\"PreviousPage\\": 2,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ParentTouchId\\": 0,\\n \\"DepId\\": 100,\\n \\"GmtModified\\": 1611207979000,\\n \\"UserTouchId\\": 0,\\n \\"CommonQueueName\\": \\"测试1\\",\\n \\"ChannelId\\": \\"4f8807a9de024507a3090b5b66a8****\\",\\n \\"TouchId\\": \\"1386****\\",\\n \\"MemberId\\": 0,\\n \\"ServicerName\\": \\"1390000****\\",\\n \\"Feedback\\": \\"xxxx\\",\\n \\"TouchType\\": 2,\\n \\"Status\\": 1,\\n \\"SwitchUser\\": \\"null\\",\\n \\"FirstTime\\": 1611209971000,\\n \\"FromId\\": 0,\\n \\"QueueId\\": 111,\\n \\"ExtAttrsString\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TouchTime\\": \\"111\\",\\n \\"ToId\\": 0,\\n \\"BuId\\": 905,\\n \\"GmtCreate\\": 1611209971000,\\n \\"CloseTime\\": 1611207976000,\\n \\"ExtAttrs\\": {\\n \\"EvaluationScore\\": 1,\\n \\"OnlineJoinRespInterval\\": 1,\\n \\"Dnis\\": \\"05712688****\\",\\n \\"OnlineSessionSource\\": 0,\\n \\"EvaluationStatus\\": 1,\\n \\"EvaluationLevel\\": 2,\\n \\"OutCallRouteNumber\\": \\"05712688****\\",\\n \\"Ani\\": \\"187****0000\\",\\n \\"EvaluationSolution\\": 0\\n },\\n \\"TouchEndReason\\": 2,\\n \\"MemberName\\": \\"访客\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 1,\\n \\"TouchContent\\": \\"1\\"\\n }\\n ],\\n \\"NextPage\\": 2\\n },\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"865658FD-80DE-5D49-ABEB-F3CC9863F4F1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryTouchListResponse>\\n <Code>200</Code>\\n <Message>Success</Message>\\n <RequestId>865658FD-80DE-5D49-ABEB-F3CC9863F4F1</RequestId>\\n <Success>true</Success>\\n <ResultData>\\n <TotalResults>100</TotalResults>\\n <NextPage>2</NextPage>\\n <CurrentPage>1</CurrentPage>\\n <TotalPage>4</TotalPage>\\n <PreviousPage>2</PreviousPage>\\n <OnePageSize>2</OnePageSize>\\n <Empty>false</Empty>\\n <Data>\\n <Status>1</Status>\\n <ToId>678026</ToId>\\n <ParentTouchId>0</ParentTouchId>\\n <ServicerName>13900001234</ServicerName>\\n <ChannelType>1</ChannelType>\\n <CloseTime>1611207976000</CloseTime>\\n <GmtModified>1611207979000</GmtModified>\\n <SwitchUser>null</SwitchUser>\\n <BuId>905</BuId>\\n <TouchTime>111</TouchTime>\\n <TouchContent>1</TouchContent>\\n <Feedback>xxxx</Feedback>\\n <TouchId>1386****</TouchId>\\n <QueueId>111</QueueId>\\n <DepId>100</DepId>\\n <TouchEndReason>2</TouchEndReason>\\n <MemberName>访客</MemberName>\\n <CommonQueueName>测试1</CommonQueueName>\\n <FirstTime>1611209971000</FirstTime>\\n <TouchType>2</TouchType>\\n <GmtCreate>1611209971000</GmtCreate>\\n <ChannelId>4f8807a9de024507a3090b5b66a8****</ChannelId>\\n <ExtAttrs>\\n <EvaluationScore>1</EvaluationScore>\\n <EvaluationLevel>2</EvaluationLevel>\\n <EvaluationSolution>0</EvaluationSolution>\\n <Ani>187****0000</Ani>\\n <OnlineJoinRespInterval>1</OnlineJoinRespInterval>\\n <OnlineSessionSource>0</OnlineSessionSource>\\n <EvaluationStatus>1</EvaluationStatus>\\n <Dnis>05712688****</Dnis>\\n <OutCallRouteNumber>05712688****</OutCallRouteNumber>\\n </ExtAttrs>\\n </Data>\\n </ResultData>\\n</QueryTouchListResponse>","errorExample":""}]', - ], - 'GetCustomerInfo' => [ - 'summary' => '获取会员信息', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetQualityProjectDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13175,39 +8720,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the console of Artificial Intelligence Cloud Call Service.', 'docRequired' => true, 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'MemberId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '82345678****', - 'exclusiveMaximum' => true, - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => true, - 'title' => '会员ID', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The quality inspection job ID.', 'docRequired' => true, 'example' => '15977801', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -13215,903 +8738,474 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'DF6A3FB7-A5AA-43BE-A65B', - 'title' => '请求ID', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'title' => '错误信息', - 'type' => 'string', - ], + 'Message' => ['description' => 'Status code description. ', 'example' => 'xxxx', 'title' => 'Message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'RequestId', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Quality inspection job information. ', 'properties' => [ - 'OuterId' => [ - 'description' => '', - 'example' => '6666666', - 'title' => '外部ID', - 'type' => 'string', - ], - 'Nick' => [ - 'description' => '', + 'Status' => ['description' => 'Quality inspection job status. Valid values: '."\n" + ."\n" + .'- **0**: Start '."\n" + .'- **1**: Shutdown ', 'example' => '0', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ServicerList' => [ + 'description' => 'Quality inspection sampling scope. ', + 'items' => ['description' => 'Quality inspection sampling scope: service agent logon names. ', 'example' => '0:55555', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', 'example' => '', - 'title' => '昵称', - 'type' => 'string', - ], - 'UserId' => [ - 'description' => '', - 'example' => '823456789023', - 'format' => 'int64', - 'title' => '会员ID', - 'type' => 'integer', ], - 'CustomizeFields' => [ - 'description' => '', - 'title' => '自定义字段', - 'type' => 'object', + 'ModifyTime' => ['description' => 'Updated At. ', 'example' => '2021-04-07 18:07:19', 'title' => '', 'type' => 'string'], + 'QualityType' => ['description' => 'Quality inspection type. Fixed value: **1** (Consultation). ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'DepList' => [ + 'description' => 'Quality inspection sampling scope. ', + 'items' => ['description' => 'Department list: a list of departments.', 'example' => '0:10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', ], - 'Photo' => [ - 'description' => '', - 'example' => 'https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ', - 'title' => '头像', - 'type' => 'string', + 'GroupList' => [ + 'description' => 'Quality inspection sampling scope.', + 'items' => ['description' => 'Quality inspection sampling scope: skill group list.', 'example' => '0:123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', ], - 'RealName' => [ - 'description' => '', + 'ProjectName' => ['description' => 'Quality inspection job name', 'example' => '自动化质检任务', 'title' => '', 'type' => 'string'], + 'Version' => ['description' => 'Quality inspection job version number.', 'example' => '1', 'format' => 'int32', 'title' => 'Version', 'type' => 'integer'], + 'CreateTime' => ['description' => 'Creation Time.', 'example' => '2021-04-07 18:07:18', 'title' => '', 'type' => 'string'], + 'Id' => ['description' => 'Quality inspection job ID.', 'example' => '15977801', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'QualityRuleIds' => [ + 'description' => 'Quality inspection rule IDs.', + 'items' => ['description' => 'Quality inspection rule data.', 'example' => '5369', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', 'example' => '', - 'title' => '真实姓名', - 'type' => 'string', ], + 'CheckFreqType' => ['description' => 'Inspection frequency type. Valid values:'."\n" + ."\n" + .'- **1**: Periodic quality inspection'."\n" + .'- **4**: Ad hoc quality inspection', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], ], - 'title' => '会员信息', + 'title' => 'Data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否请求成功', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => 'Code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'Success', 'type' => 'string'], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain Quality Inspection Job Details', + 'summary' => 'Invoke GetQualityProjectDetail to obtain the quality inspection job details. ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-05-13T16:12:41.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"OuterId\\": \\"6666666\\",\\n \\"Nick\\": \\"测试会员\\",\\n \\"UserId\\": 823456789023,\\n \\"CustomizeFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Photo\\": \\"https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ\\",\\n \\"RealName\\": \\"刘测试\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetCustomerInfoResponse>\\n<RequestId>DF6A3FB7-A5AA-43BE-A65B</RequestId>\\n<Message>successful</Message>\\n<Code>200</Code>\\n<Success>true</Success>\\n<Data>\\n <Nick>测试会员</Nick>\\n <Photo>https://thirdwx.qlogo.cn/mmopen/vi_32/Q0j4TwGTfTLSW7XPFlJDwVunXP8pr84TvltwtLlNqTlOVSFeM3bCgn57mAB4JuZZmvMW0qicqW0PyzyUdZpxiaFQ</Photo>\\n <UserId>823456789023</UserId>\\n <RealName>刘测试</RealName>\\n <OuterId>6666666</OuterId>\\n</Data>\\n</GetCustomerInfoResponse>","errorExample":""}]', - 'title' => 'GetCustomerInfo', - ], - 'GetHotlineMessageLog' => [ - 'summary' => '获取热线聊天记录', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetQualityProjectList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. ', 'docRequired' => true, 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Acid', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100****2077', - 'required' => true, - 'title' => '会话id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Quality inspection job ID (supports fuzzy search). ', 'example' => '15', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => false, 'title' => '', 'type' => 'integer', 'default' => '1'], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'Quality inspection job name (supports fuzzy search). ', 'docRequired' => true, 'example' => '质检', 'required' => false, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Quality inspection job status. Valid values: '."\n" + ."\n" + .'- **0**: Start '."\n" + .'- **1**: Shutdown '."\n", 'docRequired' => true, 'example' => '0', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The current page. Default value: **1**.', 'docRequired' => true, 'example' => '1', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => false, 'title' => 'PageNo', 'type' => 'integer'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. Default value: **10**. ', 'docRequired' => true, 'example' => '10', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => 'PageSize', 'type' => 'integer'], + ], + [ + 'name' => 'checkFreqType', + 'in' => 'query', + 'schema' => ['description' => 'The check frequency type. Valid values:'."\n" + ."\n" + .'- **1**: Periodic quality inspection'."\n" + .'- **4**: Temporary quality inspection', 'example' => '1', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Rusult', + 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '错误信息', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'xxxx', 'title' => 'Message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'RequestId', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Acid' => [ - 'description' => '', - 'example' => '100****2077', - 'title' => '会话ID', - 'type' => 'string', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '1623738027480', - 'format' => 'int64', - 'title' => '结束时间', - 'type' => 'integer', - ], - 'Content' => [ - 'description' => '', + 'description' => 'Quality inspection job information. ', + 'properties' => [ + 'PageSize' => ['description' => 'Page size. ', 'example' => '10', 'format' => 'int32', 'title' => 'PageSize', 'type' => 'integer'], + 'QualityProjectList' => [ + 'description' => 'List of quality inspection jobs. ', + 'items' => [ + 'description' => 'Quality inspection job data. ', + 'properties' => [ + 'Status' => ['description' => 'Status of the quality inspection job. ', 'example' => '0', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'ServicerList' => [ + 'description' => 'Scope of quality inspection sampling. ', + 'items' => ['description' => 'Quality inspection sampling scope: service agent logon name. ', 'example' => '0:555555', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'ModifyTime' => ['description' => 'Updated At. ', 'example' => '2021-04-07 18:07:19', 'title' => '', 'type' => 'string'], + 'QualityType' => ['description' => 'Quality inspection type. Fixed value is **1** (Consultation). ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'DepList' => [ + 'description' => 'Quality inspection sampling scope. ', + 'items' => ['description' => 'Quality inspection sampling scope: department list. ', 'example' => '0:10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'GroupList' => [ + 'description' => 'Quality inspection sampling scope. ', + 'items' => ['description' => 'Quality inspection sampling scope: skill group list.', 'example' => '0:123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'ProjectName' => ['description' => 'Quality inspection job name.', 'example' => '自动化质检任务', 'title' => '', 'type' => 'string'], + 'Version' => ['description' => 'Quality inspection job version number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'CreateTime' => ['description' => 'Creation Time.', 'example' => '2021-04-07 18:07:18', 'title' => 'CreateTime', 'type' => 'string'], + 'Id' => ['description' => 'Quality inspection job ID.', 'example' => '15977801', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'QualityRuleIds' => [ + 'description' => 'Quality inspection rule IDs.', + 'items' => ['description' => 'Quality inspection rule data.', 'example' => '5369', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'CheckFreqType' => ['description' => 'Quality inspection job frequency. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + ], + 'type' => 'object', + 'title' => '', 'example' => '', - 'title' => '会话内容', - 'type' => 'string', - ], - 'SenderType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '发送方类型（1：会员，2：坐席）', - 'type' => 'integer', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '1623738026460', - 'format' => 'int64', - 'title' => '开始时间', - 'type' => 'integer', - ], - 'Mid' => [ - 'description' => '', - 'example' => '11deca999****', - 'title' => '记录id', - 'type' => 'string', ], + 'title' => '', + 'type' => 'array', + 'example' => '', ], - 'type' => 'object', + 'Total' => ['description' => 'Total number of records. ', 'example' => '35', 'format' => 'int64', 'title' => 'Total', 'type' => 'integer'], + 'PageNo' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => 'PageNo', 'type' => 'integer'], ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用是否成功', - 'type' => 'boolean', + 'title' => 'Data', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => 'Code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => 'Success', 'type' => 'boolean'], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n {\\n \\"Acid\\": \\"100****2077\\",\\n \\"SenderType\\": 1,\\n \\"StartTime\\": 1623738026460,\\n \\"EndTime\\": 1623738027480,\\n \\"Mid\\": \\"11deca999****\\",\\n \\"Content\\": \\"您好。\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineMessageLogResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>xxxx</Message>\\n <Data>\\n <Acid>100****2077</Acid>\\n <SenderType>1</SenderType>\\n <StartTime>1623738026460</StartTime>\\n <EndTime>1623738027480</EndTime>\\n <Mid>11deca999****</Mid>\\n <Content>您好。</Content>\\n </Data>\\n</GetHotlineMessageLogResponse>","errorExample":""}]', - 'title' => 'GetHotlineMessageLog', - ], - 'GetHotlineCallAction' => [ - 'summary' => '查询话务动作结果数据', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"QualityProjectList\\": [\\n {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n }\\n ],\\n \\"Total\\": 35,\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Quality Inspection Job List ', + 'summary' => 'Invoke GetQualityProjectList to obtain the quality inspection job list. ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-04-08T12:35:57.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2021-04-08T12:35:57.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetQualityProjectLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d9****', - 'required' => false, - 'type' => 'string', - ], - ], - [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'username@example.com', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Act', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int32', - 'maximum' => '2147483647', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', - 'default' => '0', - ], - ], - [ - 'name' => 'FromSource', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'hotlinebs_out', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'Biz', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '{"name":123}', - 'required' => false, - 'title' => '业务自定义参数', - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Acc', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '{"time":1}', - 'required' => false, - 'title' => '热线自定义参数', - 'type' => 'string', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => ' '."\n" - .'result', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE339D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', - 'properties' => [ - 'TaskId' => [ - 'description' => '', - 'example' => '12345****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'SubTouchId' => [ - 'description' => '', - 'example' => '3423****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'MemberList' => [ - 'description' => '', - 'example' => '8900****', - 'type' => 'string', - ], - 'DepId' => [ - 'description' => '', - 'example' => '1223****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CaseId' => [ - 'description' => '', - 'example' => '1138902****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelId' => [ - 'description' => '', - 'example' => '2377****', - 'type' => 'string', - ], - 'TouchId' => [ - 'description' => '', - 'example' => '2235****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'BuId' => [ - 'description' => '', - 'example' => '2367****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CalloutId' => [ - 'description' => '', - 'example' => '1122****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'MemberId' => [ - 'description' => '', - 'example' => '7856876****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ActionId' => [ - 'description' => '', - 'example' => '8999****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ServicerName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'CalloutName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'IsTransfer' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - 'MemberName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'ServicerId' => [ - 'description' => '', - 'example' => '1332****', - 'format' => 'int64', - 'type' => 'integer', - ], - 'ChannelType' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int64', - 'type' => 'integer', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ActionTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ActionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ActionData' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TaskId\\": 0,\\n \\"SubTouchId\\": 0,\\n \\"MemberList\\": \\"8900****\\",\\n \\"DepId\\": 0,\\n \\"CaseId\\": 0,\\n \\"ChannelId\\": \\"2377****\\",\\n \\"TouchId\\": 0,\\n \\"BuId\\": 0,\\n \\"CalloutId\\": 0,\\n \\"MemberId\\": 0,\\n \\"ActionId\\": 0,\\n \\"ServicerName\\": \\"XX测试\\",\\n \\"CalloutName\\": \\"王XX\\",\\n \\"IsTransfer\\": \\"true\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineCallActionResponse>\\n <Code>Success</Code>\\n <Message>OK</Message>\\n <RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Data>\\n <ServicerName>XX测试</ServicerName>\\n <MemberName>匿名会员</MemberName>\\n <ChannelType>2</ChannelType>\\n <CalloutName>王XX</CalloutName>\\n <ChannelId>2377****</ChannelId>\\n <IsTransfer>true</IsTransfer>\\n <MemberList>8900****</MemberList>\\n </Data>\\n</GetHotlineCallActionResponse>","errorExample":""}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"ActionTime\\": \\"\\",\\n \\"ActionType\\": \\"\\",\\n \\"ProjectCreateTime\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"ActionData\\": \\"\\"\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'RobotCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetQualityResult' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CalledShowNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571****5678', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '131****2204', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'default' => '', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'RobotId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '350000****', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'OutId', + 'name' => 'TouchStartTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'abcdefgh', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'RecordFlag', + 'name' => 'TouchEndTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'ChannelType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'false', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'Params', + 'name' => 'HitStatus', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '116012854210^10281427*****', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"1160128*****^10281427*****\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<RobotCallResponse>\\n <Message>OK</Message>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <Data>116012854210^10281427*****</Data>\\n <Code>OK</Code>\\n</RobotCallResponse>","errorExample":""}]', - 'title' => 'RobotCall', - ], - 'ListRobotCallDialog' => [ - 'summary' => '查看对话记录', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'CallId', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 1, 'description' => '', - 'example' => '125165515022^11195613****', - 'required' => true, - 'type' => 'string', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CreateTime', + 'name' => 'QualityRuleIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 1, 'description' => '', - 'example' => '2021-05-20 00:00:00', - 'required' => true, - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Role' => [ - 'description' => '', - 'example' => 'robot', - 'type' => 'string', - ], - 'Content' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'NodeType' => [ - 'description' => '', - 'example' => 'normal', - 'type' => 'string', - ], - 'Time' => [ - 'description' => '', - 'example' => '1621483557000', - 'type' => 'string', - ], - 'Tag' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'title' => 'Schema of Response', - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"我是某某的客服，看您之前在我们家找过工作，做个回访，现在工作怎么样？\\",\\n \\"NodeType\\": \\"开场白\\",\\n \\"Time\\": \\"1621483557000\\",\\n \\"Tag\\": \\"拒绝\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListRobotCallDialogResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <Role>robot</Role>\\n <Content>您好</Content>\\n <NodeType>normal</NodeType>\\n <Time>1621483557000</Time>\\n <Tag>意图标签</Tag>\\n </Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</ListRobotCallDialogResponse>","errorExample":""}]', - 'title' => 'ListRobotCallDialog', - ], - 'ListAiccsRobot' => [ - 'summary' => '查询所有机器人列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'RobotName', + 'name' => 'ProjectIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ + 'type' => 'array', + 'items' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'required' => false, + 'maxItems' => 1, 'description' => '', + 'title' => '', 'example' => '', - 'required' => false, - 'type' => 'string', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'RobotType' => [ - 'description' => '', - 'example' => 'CUSTOM', - 'type' => 'string', - ], - 'AtSence' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'AtProfession' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'RobotName' => [ + 'type' => 'object', + 'properties' => [ + 'TotalNum' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'QualityResultResponseList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TouchStartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HitStatus' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'RuleId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TouchId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelTypeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GroupId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'InstanceName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HitDetail' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RuleName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], 'description' => '', + 'title' => '', 'example' => '', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'object', + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ChannelTypeName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'The specified parameter is invalid.', 'errorCode' => 'InvalidParameter', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"RobotType\\": \\"CUSTOM\\",\\n \\"AtSence\\": \\"新房销售\\",\\n \\"AtProfession\\": \\"房地产\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"Id\\": 0\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListAiccsRobotResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <RobotType>CUSTOM</RobotType>\\n <AtSence>新房销售</AtSence>\\n <AtProfession>房地产</AtProfession>\\n <RobotName>机器人</RobotName>\\n <Id>123456</Id>\\n </Data>\\n <Code>OK</Code>\\n <Message>successful</Message>\\n <Success>true</Success>\\n</ListAiccsRobotResponse>","errorExample":""}]', - 'title' => 'ListAiccsRobot', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 0,\\n \\"PageSize\\": 0,\\n \\"QualityResultResponseList\\": [\\n {\\n \\"GroupName\\": \\"\\",\\n \\"ProjectName\\": \\"\\",\\n \\"TouchStartTime\\": \\"\\",\\n \\"HitStatus\\": false,\\n \\"RuleId\\": \\"\\",\\n \\"ProjectId\\": \\"\\",\\n \\"TouchId\\": \\"\\",\\n \\"ChannelTypeName\\": \\"\\",\\n \\"GroupId\\": \\"\\",\\n \\"InstanceName\\": \\"\\",\\n \\"ServicerName\\": \\"\\",\\n \\"HitDetail\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"ServicerId\\": \\"\\",\\n \\"ChannelType\\": \\"\\",\\n \\"RuleName\\": \\"\\"\\n }\\n ],\\n \\"PageNo\\": 0\\n },\\n \\"Code\\": \\"\\",\\n \\"ChannelTypeName\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'ListRobotParams' => [ - 'summary' => '查询参数列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetQualityRuleDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14119,114 +9213,73 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RobotId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'QualityRuleId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'successful', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'IsEmpty' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'type' => 'integer', - ], - 'ParamCode' => [ - 'description' => '', - 'example' => 'name', - 'type' => 'string', - ], - 'ParamName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], + 'type' => 'object', + 'properties' => [ + 'RuleCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MatchType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RuleId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RuleTag' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'KeyWords' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'object', + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'array', - ], - 'Code' => [ 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"IsEmpty\\": 0,\\n \\"ParamCode\\": \\"1\\",\\n \\"ParamName\\": \\"名称\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListRobotParamsResponse>\\n <RequestId>FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB</RequestId>\\n <Data>\\n <IsEmpty>0</IsEmpty>\\n <ParamCode>name</ParamCode>\\n <ParamName>名称</ParamName>\\n </Data>\\n <Code>200</Code>\\n <Message>successful</Message>\\n <Success>true</Success>\\n</ListRobotParamsResponse>","errorExample":""}]', - 'title' => 'ListRobotParams', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"RuleCreateTime\\": \\"\\",\\n \\"MatchType\\": 0,\\n \\"RuleId\\": 0,\\n \\"RuleTag\\": 0,\\n \\"KeyWords\\": [\\n \\"\\"\\n ],\\n \\"Name\\": \\"\\"\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'GetCallSoundRecord' => [ - 'summary' => '获取通话录音文件', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetQualityRuleList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14234,100 +9287,95 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'CreateTime', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2021-10-15 08:56:23', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CallId', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '125165515022^11195613****', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Total' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'PageNo' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'QualityRuleList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleCreateTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MatchType' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RuleId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'RuleTag' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'KeyWords' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetCallSoundRecordResponse>\\n <RequestId>String\\tD9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/1001067****.wav</Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</GetCallSoundRecordResponse>","errorExample":""}]', - 'title' => 'GetCallSoundRecord', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": {\\n \\"PageSize\\": 0,\\n \\"Total\\": 0,\\n \\"PageNo\\": 0,\\n \\"QualityRuleList\\": [\\n {\\n \\"RuleCreateTime\\": \\"\\",\\n \\"MatchType\\": 0,\\n \\"RuleId\\": 0,\\n \\"RuleTag\\": 0,\\n \\"KeyWords\\": [\\n \\"\\"\\n ],\\n \\"Name\\": \\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'ListRobotNode' => [ - 'summary' => '查询机器人输出列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetQualityRuleTagList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14335,272 +9383,145 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'RobotId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100002674****', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Ok', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'description' => '', + 'type' => 'array', 'items' => [ - 'description' => '', + 'type' => 'object', 'properties' => [ - 'ProcessName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'ModelName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'IsOutput' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'NodeName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'NodeIdentifier' => [ - 'description' => '', - 'example' => '123456', - 'type' => 'string', - ], + 'RuleTagName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RuleTagId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Ok', - 'type' => 'string', - ], - 'Success' => [ 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"Ok\\",\\n \\"Data\\": [\\n {\\n \\"ProcessName\\": \\"开场白\\",\\n \\"ModelName\\": \\"模型一\\",\\n \\"IsOutput\\": 1,\\n \\"NodeName\\": \\"理财\\",\\n \\"NodeIdentifier\\": \\"12****\\"\\n }\\n ],\\n \\"Code\\": \\"Ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListRobotNodeResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <ProcessName>开场白</ProcessName>\\n <ModelName>模型一</ModelName>\\n <NodeName>理财</NodeName>\\n <IsOutput>1</IsOutput>\\n <NodeIdentifier>123456</NodeIdentifier>\\n </Data>\\n <Code>Ok</Code>\\n <Message>Ok</Message>\\n <Success>true</Success>\\n</ListRobotNodeResponse>","errorExample":""}]', - 'title' => 'ListRobotNode', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"RuleTagName\\": \\"\\",\\n \\"RuleTagId\\": 0\\n }\\n ],\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'CreateTask' => [ - 'summary' => '创建外呼任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetQueueInformation' => [ + 'summary' => 'Obtain queue information under the skill group dimension in online monitoring. Supports queries grouped by instance, time range, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'RobotId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Caller', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571****5678,0571****5679', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CallString', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The start UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'CallStringType', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'JSON', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'RetryFlag', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'RetryCount', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The current page. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'RetryInterval', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** in the response parameters to obtain the department ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'RetryStatusCode', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '200010,200011', + 'description' => 'The list of skill group IDs.', + 'items' => ['description' => 'The skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** field in the response to obtain the skill group ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'StartNow', - 'in' => 'query', - 'schema' => [ - 'description' => '', + 'title' => '', + 'type' => 'array', 'example' => '', - 'required' => false, - 'type' => 'boolean', - 'default' => 'false', ], ], [ - 'name' => 'WorkTimeList', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10:00-12:00,13:00-14:00', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to query by department grouping. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'WorkDay', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'SeatCount', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '3', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to query data grouped by skill group. Default value: **false**. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ @@ -14608,297 +9529,171 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Data list. ', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. ', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'The information is a JSON string of the List<Map> type.', 'example' => '{"tenant_id":"905","tenant_name":"非单元测试化BU","group_id":"-1","group_name":"-1","department_id":"-1","department_name":"-1","current_session_wait_cnt":0,"current_session_service_cnt":0,"date_id":"20210327","maximum_queuing_time":-1}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'The request status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>123456</Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</CreateTaskResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"current_session_wait_cnt\\\\\\":0,\\\\\\"current_session_service_cnt\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210327\\\\\\",\\\\\\"maximum_queuing_time\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain queue information by skill group dimension under online monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter description for the returned parameter Rows:'."\n" + ."\n" + .' group_name: Skill group name '."\n" + .' group_id: Skill group ID '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' date_id: Date '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' current_session_wait_cnt: Members in queue '."\n" + .' current_session_service_cnt: Members in service '."\n" + .' eventide: Event time '."\n" + .' fst_assign_time: The earliest assignment time in this queue for members waiting in line'."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueueInformation'], + ], + ], + 'ramActions' => [], ], - 'AttachTask' => [ - 'summary' => '追加任务明细', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRecordData' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'read', + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'Log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview) and view the instance ID in **Instance Management**.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CallString', + 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Session ID.', 'docRequired' => true, 'example' => '1001067****', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'Returned data.', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Data list.', + 'properties' => [ + 'Acid' => ['description' => 'Session ID.', 'example' => '1001067****', 'type' => 'string', 'title' => ''], + 'OssLink' => ['description' => 'Recording file URL.', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain a Recording File', + 'summary' => 'Invoke the GetRecordData API to obtain a recording file.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 10,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AttachTaskResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>10</Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</AttachTaskResponse>","errorExample":""}]', - 'title' => 'AttachTask', - ], - 'StartTask' => [ - 'summary' => '立即或定时启动智能外呼任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetRecordUrl' => [ + 'summary' => 'Invoke the GetRecordUrl API to obtain the incoming and outgoing calls recording link.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview) > Instance Management.', 'example' => 'ccc_xp_pre-cn-****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'StartNow', + 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The session ID.', 'example' => '1001067****', 'required' => true, 'type' => 'string', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'title' => 'Schema of Response', - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartTaskResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>true</Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</StartTaskResponse>","errorExample":""}]', - 'title' => 'StartTask', - ], - 'StopTask' => [ - 'summary' => '暂停外呼任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TaskId', + 'name' => 'RecordType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', + 'description' => 'The call type. Valid values:'."\n" + ."\n" + .'- **DUP_CALL**: Incoming and outgoing calls.'."\n" + .'- **IVR_CALL**: IVR outbound call.'."\n" + .'- **SMART_CALL**: Intelligent outbound call.', + 'example' => 'DUP_CALL', 'required' => true, - 'type' => 'integer', + 'type' => 'string', + 'enum' => ['DUP_CALL', 'IVR_CALL', 'SMART_CALL'], + 'title' => '', ], ], ], @@ -14907,91 +9702,60 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Ok', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'The data list.', + 'properties' => [ + 'Acid' => ['description' => 'The session ID.', 'example' => '1001067****', 'title' => '', 'type' => 'string'], + 'OssLink' => ['description' => 'The recording link.', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***', 'title' => '', 'type' => 'string'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"1001067****\\",\\n \\"OssLink\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com/accrec_tmp/10010679716-12-01-56.wav?***\\"\\n },\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain the incoming and outgoing calls recording link', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecordUrl'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopTaskResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>true</Data>\\n <Code>Ok</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</StopTaskResponse>","errorExample":""}]', - 'title' => 'StopTask', + 'ramActions' => [], ], - 'CancelTask' => [ - 'summary' => '删除智能外呼任务', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRtcToken' => [ + 'summary' => 'Invoke GetRtcToken to obtain the token for a shift agent.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The instance ID of Artificial Intelligence Cloud Call Service (AICCS).'."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'AccountName', + 'in' => 'query', + 'schema' => ['description' => 'The agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'example' => 'username@example.com', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ @@ -14999,66 +9763,58 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Ok', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'Successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'Returned data.', + 'example' => '{"cleansession":true,"clientId":"GID_VOIP@@@ClientId_2000000001271771_100685295007","conferenceTopic":"cs_alicom_voip_conference_pre","dataTopic":"alicom_voip_data_pre","host":"mqtt-cn-4590mdhb901.mqtt.aliyuncs.com","meetingEventKeepAliveInterval":0,"phoneTopic":"alicom_voip_phone","port":0,"reconnectTimeout":2000,"registerTime":0,"sdkClientPort":8883,"serverId":"GID_VOIP@@@MTEuMjIuMTQ1Ljgy","sgwServerTopic":"alicom_voip_server_pre","tlsport":443,"tokenData":"LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYzmBSHQsWXgdISJ1ZJ+2cxaU0jwYsoyG8Q8cCIbLZTwwaFHf7gc7pPXbJGYgJWUr5ooKsoHaVvvG34cww7W8woWE1OsmZGFDODvooOIjF1CZSorVrR8OwRdprW99yqhMhkJKh7r5f3HfiQgoJWL8b3A85RrRGCSP057skgQ5rIqVAlx7jDFrOTdLtz+krken8qYvpaVBO9wRfFyWQLvxAgNJNx3Oql/hpzc2o3+xbKGTA/P2siLn6Nee1FYk5ClpXcnvfSTM4BAauuWR+oES10VblKEKTU5R/pfjXj3UKOlZ1+OdGO93WA16BR/l1uRb3cOLqya5pjWM+oSmo0sOR7B0ATLz6K1xA0Pc+p6Mu8hZl+OdGO93WA1kj1L0h9Z6CAZG4ol/BNdIg9z6noy7yFmX450Y73dYDWSPUvSH1noIBkbiiX8E10iT0a6ypXxupQdyyrhh8j1yw6otqnw5AT5Tj5VsVWVfflXeZ8nPt1ydXC9nWeHX7K80O6vtOU9M8Qn5VrhkP0F1umbOoYs3NfM+WYZIQx4pkViQo6qqkxgbEg1l6oHJbmOVzrxYRrDTIxqgE/pb0YVJQ==","useTLS":false,"username":"LTAI27GqAW1VrcQA"}', + 'properties' => [ + 'RtcId' => ['description' => 'The identity of the endpoint that accesses through the Internet domain.', 'example' => '200000000*******', 'title' => 'rtcId', 'type' => 'string'], + 'Token' => [ + 'description' => 'Token information.', + 'enumValueTitles' => [], + 'example' => '{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}', + 'title' => '', + 'type' => 'string', + ], + 'AccountName' => ['description' => 'Account name.', 'example' => '139000000', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', ], + 'Code' => ['description' => 'Status code.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CancelTaskResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>true</Data>\\n <Code>OK</Code>\\n <Message>Ok</Message>\\n <Success>true</Success>\\n</CancelTaskResponse>","errorExample":""}]', - 'title' => 'CancelTask', - ], - 'ListTask' => [ - 'summary' => '查询任务列表', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"RtcId\\": \\"200000000*******\\",\\n \\"Token\\": \\"{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}\\",\\n \\"AccountName\\": \\"139000000\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Token for Mobile Agent', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRtcToken'], + ], ], + 'ramActions' => [], + ], + 'GetSeatInformation' => [ + 'summary' => 'Obtain agent service capacity data under online monitoring. Supports queries by instance, time range, and department group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15066,223 +9822,127 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskName', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'PageNo', + 'name' => 'startDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Start UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'PageSize', + 'name' => 'endDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'Status', + 'name' => 'pageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'STOP', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'TaskId', + 'name' => 'currentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'RobotName', + 'name' => 'depIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** in the response parameters to obtain the department ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], + [ + 'name' => 'existDepartmentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query by department grouping. Default value: **false**. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Data list. ', 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Total' => [ - 'description' => '', - 'example' => '50', - 'format' => 'int64', - 'type' => 'integer', - ], - 'PageNo' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Record' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => 'RELEASE', - 'type' => 'string', - ], - 'GmtCreate' => [ - 'description' => '', - 'example' => '1618477232000', - 'type' => 'string', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'FireTime' => [ - 'description' => '', - 'example' => '1618477232000', - 'type' => 'string', - ], - 'TaskName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'RobotId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RobotName' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CompleteCount' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rowr' => ['description' => 'The information is a JSON string of the List<Map> type.', 'example' => '{"tenant_id": "905", "tenant_name": "非单元测试化BU", "department_id": "-1", "svc_avai_capacity": 7, "svc_current_capacity": 0, "department_name": "-1", "svc_online_cnt": 3, "svc_ask_offline_servicer_num": 0, "date_id": "20210401", "svc_max_capacity": 7, "svc_rest_cnt": 0, "current_speci_ability_num": 0, "servicer_rest_cnt": 122, "max_speci_ability_num": 3, "svc_offline_cnt": 0, "svc_no_client_cnt": 3, "svc_ask_rest_servicer_num": 0}', 'title' => '', 'type' => 'string'], ], + 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"PageNo\\": 1,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"RELEASE\\",\\n \\"GmtCreate\\": \\"1618477232000\\",\\n \\"TotalCount\\": 1,\\n \\"FireTime\\": \\"1618477232000\\",\\n \\"TaskName\\": \\"测试任务\\",\\n \\"RobotId\\": 0,\\n \\"RobotName\\": \\"机器人\\",\\n \\"Id\\": 0,\\n \\"CompleteCount\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListTaskResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <PageNo>1</PageNo>\\n <PageSize>20</PageSize>\\n <Total>50</Total>\\n <Record>\\n <Status>RELEASE</Status>\\n <GmtCreate>1618477232000</GmtCreate>\\n <TotalCount>1</TotalCount>\\n <FireTime>1618477232000</FireTime>\\n <TaskName>测试任务</TaskName>\\n <RobotId>123456</RobotId>\\n <RobotName>机器人</RobotName>\\n <Id>123456</Id>\\n <CompleteCount>1</CompleteCount>\\n </Record>\\n </Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</ListTaskResponse>","errorExample":""}]', - 'title' => 'ListTask', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rowr\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain department-based agent service capability data from real-time monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned Rows parameter:'."\n" + ."\n" + .' svc_no_client_cnt: Number of idle agents '."\n" + .' svc_rest_cnt: Number of agents on short break '."\n" + .' svc_online_cnt: Number of agents currently online '."\n" + .' svc_avai_capacity: Current available service capacity '."\n" + .' svc_ask_rest_servicer_num: Number of agents requesting a short break '."\n" + .' svc_ask_offline_servicer_num: Number of agents requesting to go offline '."\n" + .' svc_offline_cnt: Number of offline agents '."\n" + .' svc_max_capacity: Maximum service capacity '."\n" + .' svc_current_capacity: Current maximum service capacity '."\n" + .' max_speci_ability_num: Maximum Whale-Plus-One service capacity '."\n" + .' current_speci_ability_num: Current Whale-Plus-One service capacity '."\n" + .' special_ability_num: Currently assignable Whale-Plus-One service capacity '."\n" + .' servicer_rest_cnt: Count of short breaks'."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSeatInformation'], + ], + ], + 'ramActions' => [], ], - 'ListTaskDetail' => [ - 'summary' => '任务详情查看通话列表', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSkillGroupAgentStatusDetails' => [ + 'summary' => 'Obtain the service status metrics of skill groups. Support grouped queries by instance, time range, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15290,93 +9950,78 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'StatusCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '000001', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Status', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'SUCCESS', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The start date as a UNIX timestamp. Unit: milliseconds.', 'example' => '1614824872', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'PageNo', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'End Datetime Variable as a UNIX timestamp. Unit: milliseconds.', 'example' => '1614824972', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int32', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'Called', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '186****0000', + 'description' => 'A list of skill group IDs.', + 'items' => ['description' => 'The skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'TaskId', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Indicates whether to query by department grouping. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'Id', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Specifies whether to query by skill group grouping. Default value: **false**. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ @@ -15384,164 +10029,75 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Ok', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', + 'description' => 'Data list. ', 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Total' => [ - 'description' => '', - 'example' => '50', - 'format' => 'int64', - 'type' => 'integer', - ], - 'PageNo' => [ - 'description' => '', - 'example' => '20', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Record' => [ - 'description' => '', - 'items' => [ - 'description' => '1', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => 'SUCCESS', - 'type' => 'string', - ], - 'Called' => [ - 'description' => '', - 'example' => '186****0000', - 'type' => 'string', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '2021-05-20 00:03:00', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '2021-05-20 00:00:00', - 'type' => 'string', - ], - 'Duration' => [ - 'description' => '', - 'example' => '30', - 'format' => 'int32', - 'type' => 'integer', - ], - 'StatusCode' => [ - 'description' => '', - 'example' => '00001', - 'type' => 'string', - ], - 'StatusCodeDesc' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Direction' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'RetryCurTimes' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Caller' => [ - 'description' => '', - 'example' => '136****0000', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'RetryTimes' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Tags' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'The current page number.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'The number of items per page.', 'example' => '2000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>.', 'example' => '{"tenant_id": "905", "tenant_name": "非单元测试化BU", "department_id": "-1", "svc_avai_capacity": 7, "svc_current_capacity": 0, "department_name": "-1", "svc_online_cnt": 3, "svc_ask_offline_servicer_num": 0, "date_id": "20210401", "svc_max_capacity": 7, "svc_rest_cnt": 0, "current_speci_ability_num": 0, "servicer_rest_cnt": 122, "max_speci_ability_num": 3, "svc_offline_cnt": 0, "svc_no_client_cnt": 3, "svc_ask_rest_servicer_num": 0}', 'title' => '', 'type' => 'string'], ], + 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 1,\\n \\"Total\\": 50,\\n \\"PageNo\\": 20,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Called\\": \\"186****0000\\",\\n \\"EndTime\\": \\"2021-05-20 00:03:00\\",\\n \\"StartTime\\": \\"2021-05-20 00:00:00\\",\\n \\"Duration\\": 30,\\n \\"StatusCode\\": \\"200100\\",\\n \\"StatusCodeDesc\\": \\"呼叫成功\\",\\n \\"Direction\\": \\"用户\\",\\n \\"RetryCurTimes\\": 1,\\n \\"Caller\\": \\"136****0000\\",\\n \\"Id\\": 0,\\n \\"RetryTimes\\": 1,\\n \\"Tags\\": \\"肯定\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListTaskDetailResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <PageNo>20</PageNo>\\n <PageSize>1</PageSize>\\n <Total>50</Total>\\n <Record>\\n <Status>SUCCESS</Status>\\n <RetryCurTimes>1</RetryCurTimes>\\n <Called>186****0000</Called>\\n <Caller>136****0000</Caller>\\n <Duration>30</Duration>\\n <Id>123456</Id>\\n <StatusCode>00001</StatusCode>\\n <StatusCodeDesc>呼叫成功</StatusCodeDesc>\\n <RetryTimes>1</RetryTimes>\\n <StartTime>2021-05-20 00:00:00</StartTime>\\n <EndTime>2021-05-20 00:03:00</EndTime>\\n <Direction>用户</Direction>\\n <Tags>标签</Tags>\\n </Record>\\n </Data>\\n <Code>OK</Code>\\n <Message>Ok</Message>\\n <Success>true</Success>\\n</ListTaskDetailResponse>","errorExample":""}]', - 'title' => 'ListTaskDetail', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\", \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\", \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_avai_capacity\\\\\\": 7, \\\\\\"svc_current_capacity\\\\\\": 0, \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\", \\\\\\"svc_online_cnt\\\\\\": 3, \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0, \\\\\\"date_id\\\\\\": \\\\\\"20210401\\\\\\", \\\\\\"svc_max_capacity\\\\\\": 7, \\\\\\"svc_rest_cnt\\\\\\": 0, \\\\\\"current_speci_ability_num\\\\\\": 0, \\\\\\"servicer_rest_cnt\\\\\\": 122, \\\\\\"max_speci_ability_num\\\\\\": 3, \\\\\\"svc_offline_cnt\\\\\\": 0, \\\\\\"svc_no_client_cnt\\\\\\": 3, \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain Skill Group Service Status Metrics', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter description for the returned Rows parameter:'."\n" + ."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' svc_no_client_cnt: Number of idle agents '."\n" + .' svc_rest_cnt: Number of agents on short break '."\n" + .' svc_online_cnt: Number of agents online '."\n" + .' svc_avai_capacity: Current available service capacity '."\n" + .' svc_ask_rest_servicer_num: Number of agents requesting short break '."\n" + .' svc_ask_offline_servicer_num: Number of agents requesting offline status '."\n" + .' svc_offline_cnt: Number of offline agents '."\n" + .' svc_max_capacity: Maximum service capacity '."\n" + .' svc_current_capacity: Current maximum service capacity '."\n" + .' max_speci_ability_num: Maximum Whale-Swallow-Plus1 service capacity '."\n" + .' current_speci_ability_num: Current Whale-Swallow-Plus1 service capacity '."\n" + .' special_ability_num: Current assignable Whale-Swallow-Plus1 service capacity '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAgentStatusDetails'], + ], + ], + 'ramActions' => [], ], - 'ListDialog' => [ - 'summary' => '查看对话记录', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSkillGroupAndAgentStatusSummary' => [ + 'summary' => 'Obtain the aggregated agent status metrics for skill groups under hotline monitoring. Supports grouped queries by instance, time range, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15549,858 +10105,936 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'InstanceId', 'in' => 'query', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it in the **Instance Management** section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'End Datetime Variable as a UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'Current page. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'DepIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'type' => 'integer', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'Called', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '130****0000', - 'required' => true, - 'type' => 'string', + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], + [ + 'name' => 'ExistDepartmentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query by department grouping. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'ExistSkillGroupGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query by skill group grouping. Default value: **false**. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'message', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '1', - 'properties' => [ - 'Role' => [ - 'description' => '', - 'example' => 'robot', - 'type' => 'string', - ], - 'Content' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'NodeType' => [ - 'description' => '', - 'example' => 'normal', - 'type' => 'string', - ], - 'Time' => [ - 'description' => '', - 'example' => '1619763900718', - 'type' => 'string', - ], - 'Tag' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - ], - 'type' => 'object', + 'description' => 'Data list. ', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>.', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210401","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0}', 'title' => '', 'type' => 'string'], ], - 'type' => 'array', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', - 'errorCode' => 'PermissionInsufficient', - ], - [ - 'errorMessage' => 'The parameter is invalid.', - 'errorCode' => 'ParameterError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"您好\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"Time\\": \\"1619763900718\\",\\n \\"Tag\\": \\"肯定\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListDialogResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Data>\\n <Role>robot</Role>\\n <Content>您好</Content>\\n <NodeType>normal</NodeType>\\n <Time>1619763900718</Time>\\n <Tag>意图标签</Tag>\\n </Data>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Success>true</Success>\\n</ListDialogResponse>","errorExample":""}]', - 'title' => 'ListDialog', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"message\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210401\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain the aggregated agent status metrics under hotline monitoring for skill groups', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the returned parameter Rows:'."\n" + ."\n" + .' n_idle_now: Current number of idle agents '."\n" + .' n_resttype_now: Current number of agents on break '."\n" + .' n_resttype1_now: Current number of agents on regular break '."\n" + .' n_resttype2_now: Current number of agents on meal break '."\n" + .' n_resttype3_now: Current number of agents on meeting break '."\n" + .' n_resttype4_now: Current number of agents on coaching break '."\n" + .' n_resttype5_now: Current number of agents on training break '."\n" + .' n_resttype98_now: Current number of agents on forced break '."\n" + .' n_resttype99_now: Current number of agents signed in but on break '."\n" + .' n_ack_now: Current number of agents in post-processing '."\n" + .' n_online_now: Current number of online agents '."\n" + .' n_busy_now: Current number of agents on calls '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' group_id: Skill group ID '."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' date_id: Date '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAndAgentStatusSummary'], + ], + ], + 'ramActions' => [], ], - 'SendCcoSmartCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSkillGroupLatitudeState' => [ + 'summary' => 'Obtain the hotline monitoring status metrics by skill group dimension. Supports queries grouped by instance, time range, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CalledShowNumber', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571****0000', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The start date as a UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'CalledNumber', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '137****0000', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'End datetime UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'VoiceCode', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'OutId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '222356****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Current page. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'PlayTimes', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'Volume', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', + 'description' => 'A list of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'Speed', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Indicates whether to group by department. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'AsrModelId', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to group by skill group. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', - 'required' => false, - 'type' => 'string', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], + 'Data' => [ + 'description' => 'List of data. ', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'The current page number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'The page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>.', 'example' => '{"tenant_id":"905","n_resttype_now":0,"tenant_name":"非单元测试化BU","n_resttype1_now":0,"group_name":"-1","department_id":"-1","department_name":"-1","n_resttype98_now":0,"n_online_now":0,"date_id":"20210329","n_resttype3_now":0,"n_resttype5_now":0,"n_busy_now":0,"n_resttype2_now":0,"group_id":"-1","n_idle_now":0,"n_resttype4_now":0,"n_ack_now":0,"n_resttype99_now":0,"maximumqueuingtime":-1}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', + ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"tenant_id\\\\\\":\\\\\\"905\\\\\\",\\\\\\"n_resttype_now\\\\\\":0,\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"n_resttype1_now\\\\\\":0,\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"department_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_resttype98_now\\\\\\":0,\\\\\\"n_online_now\\\\\\":0,\\\\\\"date_id\\\\\\":\\\\\\"20210329\\\\\\",\\\\\\"n_resttype3_now\\\\\\":0,\\\\\\"n_resttype5_now\\\\\\":0,\\\\\\"n_busy_now\\\\\\":0,\\\\\\"n_resttype2_now\\\\\\":0,\\\\\\"group_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"n_idle_now\\\\\\":0,\\\\\\"n_resttype4_now\\\\\\":0,\\\\\\"n_ack_now\\\\\\":0,\\\\\\"n_resttype99_now\\\\\\":0,\\\\\\"maximumqueuingtime\\\\\\":-1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain Hotline Monitoring Status Metrics by Skill Group Dimension', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'responseParamsDescription' => 'Parameter description for the returned Rows parameter:'."\n" + ."\n" + .' n_idle_now: Current number of idle agents '."\n" + .' n_resttype_now: Current number of agents on break '."\n" + .' n_resttype1_now: Current number of agents on regular break '."\n" + .' n_resttype2_now: Current number of agents on meal break '."\n" + .' n_resttype3_now: Current number of agents on meeting break '."\n" + .' n_resttype4_now: Current number of agents on coaching break '."\n" + .' n_resttype5_now: Current number of agents on training break '."\n" + .' n_resttype98_now: Current number of agents on forced break '."\n" + .' n_resttype99_now: Current number of agents signed in but on break '."\n" + .' n_ack_now: Current number of agents in post-processing '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' group_id: Skill group ID '."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' n_online_now: Current number of online agents '."\n" + .' n_inqueue_now: Current number of members in queue '."\n" + .' n_inservice_now: Current number of members in service '."\n" + .' time_value: UNIX timestamp '."\n" + .' fst_assign_time: Earliest assignment time in this queue, indicating when queued members were assigned'."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupLatitudeState'], + ], + ], + 'ramActions' => [], + ], + 'GetSkillGroupServiceCapability' => [ + 'summary' => 'Retrieve skill group–level service capacity data under online monitoring. Supports queries grouped by instance, time range, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AsrBaseId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'customer_service_8k', - 'required' => false, - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'AsrAlsAmId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'AsrVocabularyId', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Start UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'RecordFlag', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'PauseTime', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '800', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'MuteTime', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'ActionCodeBreak', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => 'true', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and check the **DepartmentId** field in the response to obtain the department ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'boolean', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'DynamicId', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '123456', + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** field in the response to obtain the skill group ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'fasle', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Specifies whether to query by department grouping. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'VoiceCodeParam', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query by skill group grouping. Default value: **false**. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'title' => '', 'type' => 'boolean'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Status code description. ', 'example' => 'successful', 'title' => '', 'type' => 'string'], + 'Data' => [ + 'description' => 'Data list. ', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records. ', 'example' => '4', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'A JSON string of type List<Map>.', 'example' => '{'."\n" + .' "tenant_id": "905",'."\n" + .' "tenant_name": "非单元测试化BU",'."\n" + .' "group_name": "-1",'."\n" + .' "department_id": "-1",'."\n" + .' "department_name": "-1",'."\n" + .' "svc_online_cnt": 0,'."\n" + .' "svc_ask_offline_servicer_num": 0,'."\n" + .' "date_id": "20210326",'."\n" + .' "group_id": "-1",'."\n" + .' "svc_rest_cnt": 0,'."\n" + .' "servicer_rest_cnt": 234,'."\n" + .' "svc_offline_cnt": 0,'."\n" + .' "svc_no_client_cnt": 0,'."\n" + .' "svc_ask_rest_servicer_num": 0'."\n" + .'}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', + ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], + ], + 'title' => 'Schema of Response', + 'type' => 'object', 'example' => '', - 'required' => false, - 'type' => 'string', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\n \\\\\\"tenant_id\\\\\\": \\\\\\"905\\\\\\",\\\\n \\\\\\"tenant_name\\\\\\": \\\\\\"非单元测试化BU\\\\\\",\\\\n \\\\\\"group_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"department_name\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_online_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_offline_servicer_num\\\\\\": 0,\\\\n \\\\\\"date_id\\\\\\": \\\\\\"20210326\\\\\\",\\\\n \\\\\\"group_id\\\\\\": \\\\\\"-1\\\\\\",\\\\n \\\\\\"svc_rest_cnt\\\\\\": 0,\\\\n \\\\\\"servicer_rest_cnt\\\\\\": 234,\\\\n \\\\\\"svc_offline_cnt\\\\\\": 0,\\\\n \\\\\\"svc_no_client_cnt\\\\\\": 0,\\\\n \\\\\\"svc_ask_rest_servicer_num\\\\\\": 0\\\\n}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain service capability data by skill group dimension under online monitoring', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify department or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter description for the returned Rows parameter:'."\n" + ."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' svc_no_client_cnt: Number of idle agents '."\n" + .' svc_rest_cnt: Number of agents on short break '."\n" + .' svc_online_cnt: Number of agents online '."\n" + .' svc_avai_capacity: Current available service capacity '."\n" + .' svc_ask_rest_servicer_num: Number of agents requesting short break '."\n" + .' svc_ask_offline_servicer_num: Number of agents requesting offline status '."\n" + .' svc_offline_cnt: Number of offline agents '."\n" + .' svc_max_capacity: Maximum service capacity '."\n" + .' svc_current_capacity: Current maximum service capacity '."\n" + .' max_speci_ability_num: Maximum Whale-Swallow-Plus1 service capacity '."\n" + .' current_speci_ability_num: Current Whale-Swallow-Plus1 service capacity '."\n" + .' special_ability_num: Currently assignable Whale-Swallow-Plus1 service capacity '."\n" + .' servicer_rest_cnt: Count of short breaks '."\n" + .' pk_id: Primary key '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceCapability'], + ], + ], + 'ramActions' => [], + ], + 'GetSkillGroupServiceStatus' => [ + 'summary' => 'Obtain the service status metrics of skill groups in online reports. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SessionTimeout', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '120', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'ActionCodeTimeBreak', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '120', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'TtsConf', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'Start date UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'TtsStyle', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xiaoyun', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'End date UNIX timestamp. Unit: milliseconds.', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'TtsVolume', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'TtsSpeed', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'BackgroundFileCode', + 'name' => 'AgentIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', + 'description' => 'List of agent IDs.', + 'items' => ['description' => 'Agent ID.'."\n" + ."\n" + .'You can invoke the [GetAgent](~~2717961~~) API and view the **AgentId** in the response parameters to obtain the agent ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'BackgroundVolume', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '4', - 'minimum' => '-4', + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID. '."\n" + ."\n" + .'You can invoke the [GetAllDepartment](~~2717975~~) API and view the **DepartmentId** in the response parameters to obtain the department ID.', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'BackgroundSpeed', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](~~2717970~~) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], 'required' => false, - 'type' => 'integer', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'EnableITN', + 'name' => 'TimeLatitudeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'Time latitude type. Valid values: '."\n" + .'- **minute**: Minute. '."\n" + .'- **hour**: Hour. '."\n" + .'- **day**: Day.', 'example' => 'minute', 'required' => false, 'title' => '', 'type' => 'string'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '16012854210^10281427****', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"16012854210^10281427****\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<SendCcoSmartCallResponse>\\n <Message>OK</Message>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <Data>OK</Data>\\n <Code>116012854210^10281427****</Code>\\n</SendCcoSmartCallResponse>","errorExample":""}]', - ], - 'SendCcoSmartCallOperate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ExistAgentGrouping', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query by skill group. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['description' => 'Specifies whether to query by department group. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'CallId', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '116012854210^102814279****', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to query by skill group. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'Command', + 'name' => 'ExistRobotInstanceGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'parallelBridge', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to query by robot instance group. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'Param', + 'name' => 'ExistChannelInstanceGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'Param', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to query by Channel instance group. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', + 'description' => 'List of data.', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records.', 'example' => '4', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '2000', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'Information in the form of a JSON string of type List<Map>.', 'example' => '{"online_40s_transfer_ready_cnt":382,"minute_id":"-1","online_unsatis_cnt":0,"online_simple_cnt":0,"average_queue_time":"0.39","service_pickup":"7752","online_service_time_len":220753,"online_direct_give_up_len":1187,"channel_instance_name":"-1","servicer_id":"-1","tenant_name":"非单元测试化BU","group_name":"-1","online_30s_transfer_ready_cnt":382}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'string'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<SendCcoSmartCallOperateResponse>\\n <Message>OK</Message>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <Data>true</Data>\\n <Code>OK</Code>\\n</SendCcoSmartCallOperateResponse>","errorExample":""}]', - 'title' => 'SendCcoSmartCallOperate', + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageSize\\": 2000,\\n \\"PageNum\\": 1,\\n \\"Rows\\": \\"{\\\\\\"online_40s_transfer_ready_cnt\\\\\\":382,\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_unsatis_cnt\\\\\\":0,\\\\\\"online_simple_cnt\\\\\\":0,\\\\\\"average_queue_time\\\\\\":\\\\\\"0.39\\\\\\",\\\\\\"service_pickup\\\\\\":\\\\\\"7752\\\\\\",\\\\\\"online_service_time_len\\\\\\":220753,\\\\\\"online_direct_give_up_len\\\\\\":1187,\\\\\\"channel_instance_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"group_name\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"online_30s_transfer_ready_cnt\\\\\\":382}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain the service status metrics of skill groups under an online report', + 'description' => '### Queries per second (QPS) limits '."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API invocation frequency: 100 times per second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'responseParamsDescription' => 'Parameter Guide for the returned Rows parameter:'."\n" + ."\n" + .' date_id: Date '."\n" + .' hour_id: Hour '."\n" + .' minute_id: Minute—5-minute intervals, such as 05, 10, 00, 15 '."\n" + .' servicer_id: Customer service agent ID '."\n" + .' servicer_name: Customer service agent name '."\n" + .' group_id: Skill group ID '."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' robot_instance_id: Robot instance ID '."\n" + .' robot_instance_name: Robot instance name '."\n" + .' channel_instance_id: Channel instance ID '."\n" + .' channel_instance_name: Channel instance name '."\n" + .' online_direct_request_cnt: Number of user-initiated service requests (direct connection) '."\n" + .' online_transfer_request_cnt: Number of user service requests transferred in '."\n" + .' online_direct_ready_cnt: Number of user-initiated services accepted (direct connection) '."\n" + .' online_transfer_ready_cnt: Number of transferred-in user services accepted '."\n" + .' online_transfer_in_give_up_cnt: Number of user abandonments after transfer (not accepted) '."\n" + .' online_transfer_out_cnt: Total number of transfers out (it is recommended to obtain this metric directly by marking actions in the product) '."\n" + .' online_direct_give_up_cnt: Number of abandonments (direct connection)—user-initiated requests abandoned '."\n" + .' online_transfer_give_up_cnt: Number of abandonments (transferred in)—abandoned after being transferred in '."\n" + .' online_10s_direct_ready_cnt: Number of services accepted within 10 seconds (direct connection) '."\n" + .' online_10s_transfer_ready_cnt: Number of services accepted within 10 seconds (transferred in) '."\n" + .' online_20s_direct_ready_cnt: Number of services accepted within 20 seconds (direct connection) '."\n" + .' online_20s_transfer_ready_cnt: Number of services accepted within 20 seconds (transferred in) '."\n" + .' online_30s_direct_ready_cnt: Number of services accepted within 30 seconds (direct connection) '."\n" + .' online_30s_transfer_ready_cnt: Number of services accepted within 30 seconds (transferred in) '."\n" + .' online_40s_direct_ready_cnt: Number of services accepted within 40 seconds (direct connection) '."\n" + .' online_40s_transfer_ready_cnt: Number of services accepted within 40 seconds (transferred in) '."\n" + .' online_60s_direct_ready_cnt: Number of services accepted within 60 seconds (direct connection) '."\n" + .' online_60s_transfer_ready_cnt: Number of services accepted within 60 seconds (transferred in) '."\n" + .' online_service_time_len: Total service duration—the time from when the agent started serving to when the service ended (if a transfer occurred, the service end time equals the transfer time) '."\n" + .' online_direct_wait_len: Total waiting duration (direct connection)—from queue entry to acceptance for direct connections '."\n" + .' online_transfer_wait_len: Total waiting duration (transferred in)—from queue entry to acceptance for transferred-in requests '."\n" + .' online_direct_give_up_len: Total abandonment duration (direct connection)—from queue entry to abandonment for direct connections '."\n" + .' online_transfer_give_up_len: Total abandonment duration (transferred in)—from queue entry to abandonment for transferred-in requests (if abandoned, the duration is counted under the last target skill group) '."\n" + .' online_direct_response_len: Response duration (direct connection)—average interval between a member’s message and the agent’s reply '."\n" + .' online_transfer_response_len: Response duration (transferred in)—average interval between a member’s message and the agent’s reply '."\n" + .' online_direct_response_times: Number of responses (direct connection)—number of intervals between a member’s message and the agent’s reply '."\n" + .' online_transfer_response_times: Number of responses (transferred in)—number of intervals between a member’s message and the agent’s reply '."\n" + .' online_satis_cnt: Number of satisfied ratings—from touch evaluations '."\n" + .' online_simple_cnt: Number of neutral ratings—from touch evaluations '."\n" + .' online_unsatis_cnt: Number of dissatisfied ratings—from touch evaluations ', + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceStatus'], + ], + ], + 'ramActions' => [], ], - 'CreateAiOutboundTask' => [ - 'summary' => '创建智能外呼任务（预测式外呼、自动外呼）', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSkillGroupStatusTotal' => [ + 'summary' => 'Obtain the total status count of skill groups under hotline reports. Supports grouped queries by instance, time range, agent, department, and skill group.'."\n", + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'cc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Type', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => true, - 'title' => '任务类型（2:预测式外呼3:自动外呼）', - 'type' => 'integer', - 'enum' => [ - '2', - '3', - ], - ], + 'schema' => ['description' => 'Start Datetime Variable UNIX timestamp. Unit: milliseconds.', 'example' => '1615083365000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'Name', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xx外呼任务', - 'maxLength' => 15, - 'minLength' => 1, - 'required' => true, - 'title' => '任务名（1～15字符）', - 'type' => 'string', - ], + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds. ', 'example' => '1617761765000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'Description', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'maxLength' => 100, - 'required' => false, - 'title' => '任务描述（0～100字符）', - 'type' => 'string', - ], + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'OutboundNums', + 'name' => 'CurrentPage', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'AgentIds', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '["0571****5678","0571****5678"]', - 'required' => true, - 'type' => 'string', - ], - 'required' => true, - 'title' => '外呼主叫号码', + 'description' => 'List of agent IDs.', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and view the **AgentId** in the response parameters, which is the agent ID. ', 'example' => '111', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'NumRepeated', + 'name' => 'DepIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => true, - 'title' => '被叫号码重复策略（0任务内去重，1不去重）', - 'type' => 'integer', - 'enum' => [ - '0', - '1', - ], + 'description' => 'List of department IDs.', + 'items' => ['description' => 'Department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getalldepartment) API and view the **DepartmentId** in the response parameters to obtain the department ID.', 'example' => '123', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'HandlerId', + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', - 'type' => 'integer', + 'description' => 'List of skill group IDs.', + 'items' => ['description' => 'Skill group ID.'."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'example' => '100', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'ExecutionTime', + 'name' => 'TimeLatitudeType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', - 'required' => true, - 'title' => '任务执行时间', - 'type' => 'string', - ], + 'schema' => ['description' => 'Time latitude type. Valid values:'."\n" + ."\n" + .'- **minute**: Minute.'."\n" + .'- **hour**: Hour.'."\n" + .'- **day**: Day.', 'example' => 'minute', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ConcurrentRate', + 'name' => 'ExistAgentGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'title' => '自动外呼的呼叫并发', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Whether to query by agent group. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No. ', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'RecallRule', + 'name' => 'ExistDepartmentGrouping', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'properties' => [ - 'Count' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '3', - 'minimum' => '1', - 'required' => false, - 'title' => '重呼次数（1～3）', - 'type' => 'integer', - ], - 'Interval' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '60', - 'minimum' => '1', - 'required' => false, - 'title' => '重呼间隔时间（1～60分钟）', - 'type' => 'integer', - ], - ], - 'required' => false, - 'title' => '失败重呼策略（为空则不重呼）', - 'type' => 'object', - ], + 'schema' => ['description' => 'Whether to query by department group. Default value: **false**. Valid values: '."\n" + ."\n" + .'- **true**: Yes. '."\n" + .'- **false**: No. ', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], [ - 'name' => 'ForecastCallRate', + 'name' => 'ExistSkillGroupGrouping', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1.5', - 'format' => 'float', - 'maximum' => '100', - 'minimum' => '1', - 'required' => false, - 'title' => '预测式外呼固定外呼比例（>=1）', - 'type' => 'number', - ], + 'schema' => ['description' => 'Specifies whether to query by skill group grouping. Default value: **false**. Valid values:'."\n" + ."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'false', 'required' => false, 'title' => '', 'type' => 'boolean'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求ID', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => '任务id', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'List of data.', + 'properties' => [ + 'TotalNum' => ['description' => 'Total number of records.', 'example' => '4', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageNum' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '2000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Rows' => ['description' => 'Information as a JSON string of type List<Map>.', 'example' => '{"minute_id":"-1","call_out_intervene_servicer_cnt":26,"call_out_servicer_cnt":35,"call_out_intervene_60s_cnt":155,"servicer_real_name":"--","call_in_sep_normal_cnt":0,"call_out_intervene_30s_cnt":235,"servicer_id":"-1","tenant_name":"非单元测试化BU","call_out_sep_sat_cnt":1}', 'title' => '', 'type' => 'string'], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the Request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API invoke succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: failed.'."\n", 'example' => 'true', 'title' => '', 'type' => 'string'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>123456</Data>\\n</CreateAiOutboundTaskResponse>","errorExample":""}]', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TotalNum\\": 4,\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 2000,\\n \\"Rows\\": \\"{\\\\\\"minute_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"call_out_intervene_servicer_cnt\\\\\\":26,\\\\\\"call_out_servicer_cnt\\\\\\":35,\\\\\\"call_out_intervene_60s_cnt\\\\\\":155,\\\\\\"servicer_real_name\\\\\\":\\\\\\"--\\\\\\",\\\\\\"call_in_sep_normal_cnt\\\\\\":0,\\\\\\"call_out_intervene_30s_cnt\\\\\\":235,\\\\\\"servicer_id\\\\\\":\\\\\\"-1\\\\\\",\\\\\\"tenant_name\\\\\\":\\\\\\"非单元测试化BU\\\\\\",\\\\\\"call_out_sep_sat_cnt\\\\\\":1}\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Obtain the total status quantity of skill groups under the hotline report', + 'description' => '- Before invoking this API, ensure that you have [activated the service](https://help.aliyun.com/zh/aiccs/user-guide/activate-aiccs?spm=a2c4g.11186623.0.0.38365923RQDwdH) and [created an instance](https://help.aliyun.com/zh/aiccs/user-guide/create-an-instance?spm=a2c4g.11186623.0.0.8e0b5a2fWNeRUn). '."\n" + .'- If you need to specify agent, department, or skill group information, refer to the guidance in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times per second. '."\n" + .'- API-wide invocation frequency: 100 times per second. '."\n" + ."\n" + .'> Throttling will be triggered if the total invocations from multiple users exceed the API frequency limit.'."\n", + 'responseParamsDescription' => 'Parameter Guide for the Rows field in the response:'."\n" + ."\n" + .' date_id: Date '."\n" + .' hour_id: Hour '."\n" + .' minute_id: Minute '."\n" + .' servicer_id: Agent ID '."\n" + .' servicer_name: Agent name '."\n" + .' servicer_real_name: Agent real name '."\n" + .' group_id: Skill group ID '."\n" + .' group_name: Skill group name '."\n" + .' department_id: Department ID '."\n" + .' department_name: Department name '."\n" + .' tenant_id: Tenant ID '."\n" + .' tenant_name: Tenant name '."\n" + .' inline_cnt: Incoming call volume '."\n" + .' request_cnt: Request volume (in-progress volume minus reassign volume) '."\n" + .' ready_cnt: Answered call volume '."\n" + .' reassign_cnt: Reassigned volume '."\n" + .' ready_cnt_60s: Calls answered within 60 seconds '."\n" + .' ringqueue_len: Duration from entering queue to ringing '."\n" + .' ringtime_len: Duration from ringing to answer '."\n" + .' queue_len: Duration from entering queue to answer '."\n" + .' service_time_len: Service duration from answer to end '."\n" + .' give_up_len: Total abandonment duration from entering queue to end '."\n" + .' call_out_cnt: Outbound call volume '."\n" + .' call_out_intervene_cnt: Total ringing duration for outbound calls (from ringing to end) '."\n" + .' call_out_sep_sat_cnt: Satisfied outbound hotline evaluations '."\n" + .' call_out_sep_normal_cnt: Neutral outbound hotline evaluations '."\n" + .' call_out_sep_unsat_cnt: Dissatisfied outbound hotline evaluations '."\n" + .' call_out_unsep_cnt: Outbound hotline evaluations with participation but no rating '."\n" + .' call_in_unsep_cnt: Inbound hotline evaluations with participation but no rating '."\n" + .' call_in_sep_sat_cnt: Satisfied inbound hotline evaluations '."\n" + .' call_in_sep_normal_cnt: Neutral inbound hotline evaluations '."\n" + .' call_in_sep_unsat_cnt: Dissatisfied inbound hotline evaluations '."\n" + .' call_out_intervene_20s_cnt: Outbound calls connected with duration >20 seconds '."\n" + .' call_out_intervene_30s_cnt: Outbound calls connected with duration >30 seconds '."\n" + .' call_out_intervene_60s_cnt: Outbound calls connected with duration >60 seconds '."\n" + .' call_in_intervene_20s_cnt: Inbound calls connected with duration >20 seconds '."\n" + .' call_in_intervene_30s_cnt: Inbound calls connected with duration >30 seconds '."\n" + .' call_in_intervene_60s_cnt: Inbound calls connected with duration >60 seconds '."\n", + 'changeSet' => [ + ['createdAt' => '2021-04-07T12:18:56.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupStatusTotal'], + ], + ], + 'ramActions' => [], ], - 'CreateAiOutboundTaskBatch' => [ - 'summary' => '创建智能外呼任务批次', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'HangUpDoubleCall' => [ + 'summary' => 'Cancel dual-call.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16408,36 +11042,17 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'TaskId', + 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Session ID.', 'example' => '68255155****', 'required' => false, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ @@ -16445,751 +11060,358 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int32', - 'title' => '新建的任务批次版本id', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": 123456,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateAiOutboundTaskBatchResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>123456</Data>\\n</CreateAiOutboundTaskBatchResponse>","errorExample":""}]', - 'title' => 'CreateAiOutboundTaskBatch', - ], - 'DeleteAiOutboundTask' => [ - 'summary' => '删除智能外呼任务', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Cancel dual-call', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HangUpDoubleCall'], + ], ], + 'ramActions' => [], + ], + 'HangupCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name (agent logon name).', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'Hotline session ID.', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Status code description.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</DeleteAiOutboundTaskResponse>","errorExample":""}]', - 'title' => 'DeleteAiOutboundTask', - ], - 'GetAiOutboundTaskBizData' => [ - 'summary' => '获取智能外呼任务业务自定义信息', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Hang Up Call', + 'summary' => 'Invoke HangupCall to execute the agent hang-up operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'HangupOperate' => [ + 'summary' => 'Hangs up a call in Communication Intelligence Engine.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '259150', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The call ID. Obtain this ID from the response of the [LlmSmartCall](~~2862828~~) or [LlmSmartCallEncrypt](~~2881065~~) operation.', 'type' => 'string', 'required' => true, 'example' => '14777672****^13452272****', 'title' => ''], ], [ - 'name' => 'ChannelId', + 'name' => 'ImmediateHangup', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => true, - 'title' => '入呼channelId', - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to hang up the call immediately. Valid values:'."\n" + ."\n" + .'- true (default): Hangs up the call immediately.'."\n" + ."\n" + .'- false: Hangs up the call after the current playback finishes.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'BizData' => [ - 'description' => '', - 'example' => '{"customer":123}', - 'title' => '业务自定义信息', - 'type' => 'string', - ], - 'TaskId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => '任务ID', - 'type' => 'integer', - ], - 'PhoneNum' => [ - 'description' => '', - 'example' => '158****0000', - 'title' => '外呼号码', - 'type' => 'string', - ], - 'CaseId' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'title' => 'id', - 'type' => 'integer', - ], - ], - 'title' => '本次呼叫关联的业务信息', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], 'title' => 'Schema of Response', + 'description' => 'The response schema.', 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'EFD543DD-E087-54A2-AC0B-54E0656511D7'], + 'Code' => ['description' => 'The status code. A value of \'OK\' indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Mesage' => ['description' => 'The status message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Result' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- **true**: The hang-up was successful.'."\n" + ."\n" + .'- **false**: The hang-up operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"BizData\\": \\"{\\\\\\"customer\\\\\\":123}\\",\\n \\"TaskId\\": 123456,\\n \\"PhoneNum\\": \\"158****0000\\",\\n \\"CaseId\\": 123\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAiOutboundTaskBizDataResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>\\n <CaseId>123</CaseId>\\n <PhoneNum>158****0000</PhoneNum>\\n <BizData>{\\"customer\\":123}</BizData>\\n <TaskId>123456</TaskId>\\n </Data>\\n</GetAiOutboundTaskBizDataResponse>","errorExample":""}]', - 'title' => 'GetAiOutboundTaskBizData', - ], - 'GetAiOutboundTaskExecDetail' => [ - 'summary' => '智能外呼任务执行详情', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.CallId', 'errorMessage' => 'The parameter CallId is invalid.', 'description' => 'The parameter CallId is invalid.'."\n"], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EFD543DD-E087-54A2-AC0B-54E0656511D7\\",\\n \\"Code\\": \\"OK\\",\\n \\"Mesage\\": \\"OK\\",\\n \\"Result\\": true\\n}","type":"json"}]', + 'title' => 'Intelligent Engine Proactively Hangs Up a Call in Communication', + 'description' => '- Before you hang up a call in Communication Intelligence Engine, ensure that a call has been initiated by a large model.'."\n" + ."\n" + .'- If a call has not been initiated, use the [LlmSmartCall](~~2862828~~) or [LlmSmartCallEncrypt](~~2881065~~) operation to do so.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], - ], + 'ramActions' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:HangupOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'HangupThirdCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BatchVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '任务批次', - 'type' => 'integer', - ], + 'AK' => [], ], [ - 'name' => 'PhoneNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '150****000', - 'required' => false, - 'title' => '手机号', - 'type' => 'string', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'CaseStatus', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '单条号码任务执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）', - 'type' => 'integer', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request, used for idempotency validation; can be generated using UUID', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CreateTimeStart', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1632289999000', - 'format' => 'int64', - 'required' => false, - 'title' => '号码导入起始时间戳（毫秒）', - 'type' => 'integer', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1632290119000', - 'format' => 'int64', - 'required' => false, - 'title' => '号码导入结束时间戳（毫秒）', - 'type' => 'integer', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name (agent logon name)', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '50', - 'minimum' => '1', - 'required' => true, - 'title' => '分页大小（<=50）', - 'type' => 'integer', - ], + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'The acid from the WebSocket after an incoming call', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => true, - 'title' => '当前页数', - 'type' => 'integer', - ], + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'The jobId from the WebSocket after an incoming call', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CaseId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'title' => '单条外呼id', - 'type' => 'integer', - ], + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'The connId from the WebSocket after an incoming call', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '分页大小', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '199', - 'format' => 'int32', - 'title' => '总数', - 'type' => 'integer', - ], - 'List' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '执行状态（1：待呼叫，2:呼叫中，3:已完成，4:已终止，5:待重呼）', - 'type' => 'integer', - ], - 'StatusDesc' => [ - 'description' => '', - 'example' => '待呼叫', - 'format' => 'int32', - 'title' => '执行状态描述', - 'type' => 'integer', - ], - 'BizData' => [ - 'description' => '', - 'example' => '123', - 'title' => '业务自定义信息', - 'type' => 'string', - ], - 'BatchVersion' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '任务批次', - 'type' => 'integer', - ], - 'PhoneNum' => [ - 'description' => '', - 'example' => '150****0000', - 'title' => '手机号', - 'type' => 'string', - ], - 'LastCallResult' => [ - 'description' => '', - 'example' => '未接通', - 'title' => '最后一次外呼结果', - 'type' => 'string', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '1632289999000', - 'format' => 'int64', - 'title' => '号码导入时间戳（毫秒）', - 'type' => 'integer', - ], - 'CaseId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => 'id', - 'type' => 'integer', - ], - 'CallCount' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '外呼次数', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], - 'title' => '外呼号码执行列表', - 'type' => 'array', - ], - 'HasNextPage' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否有下一页', - 'type' => 'boolean', - ], - ], - 'title' => '任务执行列表', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of a fault', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 199,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"StatusDesc\\": 0,\\n \\"BizData\\": \\"123\\",\\n \\"BatchVersion\\": 1,\\n \\"PhoneNum\\": \\"150****0000\\",\\n \\"LastCallResult\\": \\"未接通\\",\\n \\"CreateTime\\": 1632289999000,\\n \\"CaseId\\": 123456,\\n \\"CallCount\\": 1\\n }\\n ],\\n \\"HasNextPage\\": true\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAiOutboundTaskExecDetailResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>\\n <PageSize>10</PageSize>\\n <HasNextPage>true</HasNextPage>\\n <TotalResults>199</TotalResults>\\n <CurrentPage>1</CurrentPage>\\n <List>\\n <CaseId>123456</CaseId>\\n <BatchVersion>1</BatchVersion>\\n <BizData>123</BizData>\\n <PhoneNum>150****0000</PhoneNum>\\n <CallCount>1</CallCount>\\n <Status>1</Status>\\n <LastCallResult>未接通</LastCallResult>\\n <CreateTime>1632289999000</CreateTime>\\n </List>\\n </Data>\\n</GetAiOutboundTaskExecDetailResponse>","errorExample":""}]', - 'title' => 'GetAiOutboundTaskExecDetail', - ], - 'GetAiOutboundTaskDetail' => [ - 'summary' => '智能外呼任务配置详情查询', - 'methods' => [ - 'get', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + '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-way Call', + 'summary' => 'Hang up a third-party call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'HoldCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request, used for idempotency validation; can be generated using UUID', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name (agent logon name)', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'formData', + 'schema' => ['description' => 'acid in WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'JobId', + 'in' => 'formData', + 'schema' => ['description' => 'jobId in WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ConnectionId', + 'in' => 'formData', + 'schema' => ['description' => 'connId in WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => '请求ID', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', - 'type' => 'integer', - ], - 'HandlerId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', - 'type' => 'integer', - ], - 'TaskId' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'title' => '任务id', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => '', - 'title' => '任务描述', - 'type' => 'string', - ], - 'Name' => [ - 'description' => '', - 'example' => 'xx外呼任务', - 'title' => '任务名', - 'type' => 'string', - ], - 'StatusDesc' => [ - 'description' => '', - 'example' => '未开始', - 'title' => '任务状态描述', - 'type' => 'string', - ], - 'ExecutionTime' => [ - 'description' => '', - 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', - 'title' => '任务执行时间', - 'type' => 'string', - ], - 'Type' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '任务类型(2:预测式外呼，3:自动外呼)', - 'type' => 'integer', - ], - 'ConcurrentRate' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '自动外呼的并发', - 'type' => 'integer', - ], - 'NumRepeated' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'title' => '被叫号码重复策略（0去重，1不去重）', - 'type' => 'integer', - ], - 'OutboundNums' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '150****0000', - 'type' => 'string', - ], - 'title' => '外呼主叫号码', - 'type' => 'array', - ], - 'RecallRule' => [ - 'description' => '', - 'properties' => [ - 'Count' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '重呼次数', - 'type' => 'integer', - ], - 'Interval' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '重呼间隔时间（分钟）', - 'type' => 'integer', - ], - ], - 'title' => '失败重呼策略', - 'type' => 'object', - ], - 'HandlerName' => [ - 'description' => '', - 'example' => '热线技能组', - 'title' => '技能组名称或ivr名称', - 'type' => 'string', - ], - 'ForecastCallRate' => [ - 'description' => '', - 'example' => '1.2', - 'format' => 'float', - 'title' => '预测式外呼固定外呼比例', - 'type' => 'number', - ], - ], - 'title' => '任务详情', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of a fault', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Status\\": 1,\\n \\"HandlerId\\": 123456,\\n \\"TaskId\\": 123,\\n \\"Description\\": \\"房产销售\\",\\n \\"Name\\": \\"xxxxx外呼\\",\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"ExecutionTime\\": \\"{\\\\\\"TUESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"06:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"06:05\\\\\\"}],\\\\\\"MONDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"20:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"21:45\\\\\\"},{\\\\\\"start\\\\\\":\\\\\\"22:30\\\\\\",\\\\\\"end\\\\\\":\\\\\\"22:50\\\\\\"}],\\\\\\"WEDNESDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"THURSDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"FRIDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SATURDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"09:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"18:00\\\\\\"}],\\\\\\"SUNDAY\\\\\\":[{\\\\\\"start\\\\\\":\\\\\\"17:00\\\\\\",\\\\\\"end\\\\\\":\\\\\\"23:45\\\\\\"}]}\\",\\n \\"Type\\": 2,\\n \\"ConcurrentRate\\": 10,\\n \\"NumRepeated\\": 0,\\n \\"OutboundNums\\": [\\n \\"150****0000\\"\\n ],\\n \\"RecallRule\\": {\\n \\"Count\\": 2,\\n \\"Interval\\": 2\\n },\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"ForecastCallRate\\": 1.2\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAiOutboundTaskDetailResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>\\n <TaskId>123</TaskId>\\n <Status>1</Status>\\n <StatusDesc>未开始</StatusDesc>\\n <Type>2</Type>\\n <Name>xxxxx外呼</Name>\\n <Description>房产销售</Description>\\n <OutboundNums>150****0000</OutboundNums>\\n <NumRepeated>0</NumRepeated>\\n <HandlerId>123456</HandlerId>\\n <HandlerName>热线技能组</HandlerName>\\n <ExecutionTime>{\\"TUESDAY\\":[{\\"start\\":\\"06:00\\",\\"end\\":\\"06:05\\"}],\\"MONDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"},{\\"start\\":\\"20:30\\",\\"end\\":\\"21:45\\"},{\\"start\\":\\"22:30\\",\\"end\\":\\"22:50\\"}],\\"WEDNESDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"THURSDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"FRIDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"SATURDAY\\":[{\\"start\\":\\"09:00\\",\\"end\\":\\"18:00\\"}],\\"SUNDAY\\":[{\\"start\\":\\"17:00\\",\\"end\\":\\"23:45\\"}]}</ExecutionTime>\\n <ConcurrentRate>10</ConcurrentRate>\\n <RecallRule>\\n <Count>2</Count>\\n <Interval>2</Interval>\\n </RecallRule>\\n <ForecastCallRate>1.2</ForecastCallRate>\\n </Data>\\n</GetAiOutboundTaskDetailResponse>","errorExample":""}]', - 'title' => 'GetAiOutboundTaskDetail', - ], - 'UpdateAiOutboundTask' => [ - 'summary' => '更新智能外呼任务（预测式外呼、自动外呼）', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Call Hold', + 'summary' => 'Hold the call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'HotlineSessionQuery' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17197,976 +11419,676 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it in the **Instance Management** section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'Acid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Session ID. The acid received via WebSocket after an inbound call.', 'docRequired' => false, 'example' => '7719786****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'CallType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xx外呼任务', - 'maxLength' => 15, - 'minLength' => 1, - 'required' => true, - 'title' => '任务名（1～15字符）', - 'type' => 'string', - ], + 'schema' => ['description' => 'Call Type. Valid values:'."\n" + .'- **1**: Outbound call.'."\n" + .'- **2**: Inbound call.'."\n" + .'- **3**: Change owner.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'maxLength' => 100, - 'required' => false, - 'title' => '任务描述（0～100字符）', - 'type' => 'string', - ], + 'schema' => ['description' => 'Calling party number, such as a user\'s phone number, agent number, or machine number.', 'example' => '135615****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OutboundNums', + 'name' => 'CallingNumber', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '150****0000', - 'required' => true, - 'type' => 'string', - ], - 'required' => true, - 'title' => '外呼主叫号码', - 'type' => 'array', - ], + 'schema' => ['description' => 'Calling party number, such as a user\'s phone number, customer service agent number, or machine number.', 'example' => '057177****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'NumRepeated', + 'name' => 'GroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => true, - 'title' => '被叫号码重复策略（0:任务内去重，1:任务内不去重）', - 'type' => 'integer', - 'enum' => [ - '0', - '1', - ], - ], + 'schema' => ['description' => 'Skill group ID.'."\n", 'example' => '123456', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'HandlerId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => true, - 'title' => '技能组id（预测式外呼）或者ivr id（自动外呼）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Skill group name.', 'example' => '自动化技能组', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ExecutionTime', + 'name' => 'MemberId', + 'in' => 'query', + 'schema' => ['description' => 'Membership ID.', 'example' => '7856****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'MemberName', + 'in' => 'query', + 'schema' => ['description' => 'Membership name.'."\n", 'example' => '匿名会员', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'QueryEndTime', + 'in' => 'query', + 'schema' => ['description' => 'End UNIX timestamp. Unit: milliseconds.', 'example' => '1614829721', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'QueryStartTime', + 'in' => 'query', + 'schema' => ['description' => 'Start UNIX timestamp. Unit: ms.', 'example' => '1614828721', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'RequestId', + 'in' => 'query', + 'schema' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ServicerName', + 'in' => 'query', + 'schema' => ['description' => 'Agent Name.', 'example' => '刘测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ServicerId', + 'in' => 'query', + 'schema' => ['description' => 'Agent ID.'."\n", 'example' => '555555', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'query', + 'schema' => ['description' => 'Extension parameters.'."\n", 'example' => 'xxxx', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'maximum' => '50', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. The value must be greater than **0**. Default Value: **1**.', 'example' => '1', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'CallResult', 'in' => 'query', 'schema' => [ - 'description' => '', - 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', - 'required' => true, - 'title' => '任务执行时间', + 'description' => 'Call result. Valid values: '."\n" + ."\n" + .'- **normal**: Normal hang-up. '."\n" + .'- **touchRouteError**: Queue hang-up. '."\n" + .'- **touchInQueue**: Queue hang-up. '."\n" + .'- **touchInLoss**: Queue hang-up. '."\n" + .'- **userHangup**: User hang-up or IVR hang-up. '."\n" + .'- **sysHangup**: System hang-up or IVR hang-up. '."\n" + .'- **transferAgent**: User hang-up or IVR hang-up. '."\n" + .'- **dailing**: Agent hang-up during ringing. '."\n" + .'- **TouchRingCallLoss**: Queue hang-up during ringing.', + 'example' => 'normal', + 'required' => false, 'type' => 'string', + 'enum' => ['normal', 'queueClose', 'dailingClose', 'ivrClose'], + 'title' => '', ], ], [ - 'name' => 'ConcurrentRate', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Global unique ID (GUID) of the call detail.'."\n", 'example' => 'acc1c58dab4a4****0e3813c66', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'AcidList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', + 'description' => 'Session ID List.', + 'items' => ['description' => 'The `acid` from WebSocket after an inbound call.', 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'title' => '自动外呼的并发', - 'type' => 'integer', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RecallRule', + 'name' => 'CallTypeList', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'properties' => [ - 'Count' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'maximum' => '3', - 'minimum' => '1', - 'required' => false, - 'title' => '失败重呼次数（1～3次）', - 'type' => 'integer', - ], - 'Interval' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'maximum' => '60', - 'minimum' => '1', - 'required' => false, - 'title' => '失败重呼间隔时间（1～60分钟）', - 'type' => 'integer', - ], - ], + 'description' => 'Call Type List.', + 'items' => ['description' => 'Call Type. Valid values:'."\n" + .'- **1**: Outbound call.'."\n" + .'- **2**: Inbound call.'."\n" + .'- **3**: Change owner.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 5, 'required' => false, - 'title' => '失败重呼策略', - 'type' => 'object', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ForecastCallRate', + 'name' => 'GroupIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '1.2', - 'format' => 'float', - 'maximum' => '100', - 'minimum' => '1', + 'description' => 'List of skill group IDs.'."\n", + 'items' => ['description' => 'Skill group ID.'."\n", 'example' => '123456', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'title' => '预测式外呼固定外呼比例（>=1）', - 'type' => 'number', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'CallingNumberList', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'ok', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'ok', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => 'List of calling numbers.'."\n", + 'items' => ['description' => 'Calling number.'."\n", 'example' => '0571773****', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"ok\\",\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>ok</Message>\\n <Code>ok</Code>\\n <Success>true</Success>\\n</UpdateAiOutboundTaskResponse>","errorExample":""}]', - 'title' => 'UpdateAiOutboundTask', - ], - 'InsertAiOutboundPhoneNums' => [ - 'summary' => '智能外呼任务导入号码', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', + 'name' => 'CalledNumberList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', + 'description' => 'List of called numbers.', + 'items' => ['description' => 'Called number.', 'example' => '135615****', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskId', + 'name' => 'MemberIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', + 'description' => 'Membership List.', + 'items' => ['description' => 'Membership ID.', 'example' => '7856876', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BatchVersion', + 'name' => 'ServicerIdList', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', + 'description' => 'List of agent IDs.'."\n", + 'items' => ['description' => 'Agent ID.'."\n", 'example' => '555555', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'title' => '任务批次号（不填则导入到默认批次）', - 'type' => 'integer', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Details', + 'name' => 'CallResultList', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'BizData' => [ - 'description' => '', - 'example' => 'xxxx', - 'required' => false, - 'title' => '自定义信息', - 'type' => 'string', - ], - 'PhoneNum' => [ - 'description' => '', - 'example' => '150****0000', - 'required' => false, - 'title' => '手机号', - 'type' => 'string', - ], - ], - 'required' => false, - 'type' => 'object', - ], - 'required' => true, - 'title' => '号码详情(至多30条)', + 'description' => 'List of call results.'."\n", + 'items' => ['description' => 'Call result. Valid values: '."\n" + ."\n" + .'- **normal**: Normal call end. '."\n" + .'- **queueClose**: Queue hang-up. '."\n" + .'- **dailingClose**: Ringing hang-up. '."\n" + .'- **ivrClose**: IVR hang-up.'."\n", 'example' => 'normal', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE339D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Call data.', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '导入总数', - 'type' => 'integer', - ], - 'SuccessCount' => [ - 'description' => '', - 'example' => '7', - 'format' => 'int32', - 'title' => '导入成功数量', - 'type' => 'integer', - ], - 'FailInfo' => [ - 'description' => '', + 'TotalCount' => ['description' => 'Total number of records.', 'example' => '26', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'PageSize' => ['description' => 'Number of items per page.', 'example' => '10', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'PageNumber' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'CallDetailRecord' => [ + 'description' => 'Call detail records.', 'items' => [ - 'description' => '', + 'description' => 'Call record information.', 'properties' => [ - 'Msg' => [ - 'description' => '', - 'example' => '号码格式异常', - 'title' => '失败原因描述', - 'type' => 'string', - ], - 'BizData' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '自定义信息', - 'type' => 'string', - ], - 'PhoneNum' => [ - 'description' => '', - 'example' => '150****0000', - 'title' => '外呼被叫号码', - 'type' => 'string', - ], + 'GroupName' => ['description' => 'Skill group name. '."\n" + .'> When CallType is **1**, outbound call scenarios do not include skill group information.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'CallResult' => ['description' => 'Call result. Valid values:'."\n" + ."\n" + .'- **normal**: Normal hang-up.'."\n" + .'- **touchRouteError**: Queue hang-up.'."\n" + .'- **touchInQueue**: Queue hang-up.'."\n" + .'- **touchInLoss**: Queue hang-up.'."\n" + .'- **userHangup**: User hang-up or IVR hang-up.'."\n" + .'- **sysHangup**: System hang-up or IVR hang-up.'."\n" + .'- **transferAgent**: User hang-up or IVR hang-up.'."\n" + .'- **dailing**: Agent hang-up or ring-off hang-up.'."\n" + .'- **TouchRingCallLoss**: Queue hang-up or ring-off hang-up.', 'example' => 'normal', 'type' => 'string', 'title' => ''], + 'CalledNumber' => ['description' => 'Called number.', 'example' => '135615*****', 'type' => 'string', 'title' => ''], + 'Acid' => ['description' => 'Session ID. The acid in WebSocket after an incoming call.', 'example' => '7719786', 'type' => 'string', 'title' => ''], + 'CallType' => ['description' => 'Call type. Valid values:'."\n" + .'- **1**: Outbound call'."\n" + .'- **2**: Inbound call'."\n" + .'- **3**: Change owner', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'QueueUpContinueTime' => ['description' => 'Queue duration.', 'example' => '4', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'PassiveTransferId' => ['description' => 'Agent ID. The phone number to which the call is transferred.'."\n" + .'> This field is null in non-transfer scenarios.', 'example' => '12', 'type' => 'string', 'title' => ''], + 'CallingNumber' => ['description' => 'Calling party number, such as a user\'s phone number, agent number, or machine number.', 'example' => '0571773', 'type' => 'string', 'title' => ''], + 'MemberId' => ['description' => 'Membership ID.', 'example' => '7856876', 'type' => 'string', 'title' => ''], + 'ServicerName' => ['description' => 'Agent name.'."\n" + .'> Agent information is unavailable before the call is assigned to an agent in inbound scenarios.', 'example' => '刘测试', 'type' => 'string', 'title' => ''], + 'OutQueueTime' => ['description' => 'The time when the hotline call is assigned and dequeued.'."\n" + ."\n" + .'> Outbound scenarios do not have a dequeue time.', 'example' => '2020-10-02 22:32:59', 'type' => 'string', 'title' => ''], + 'RingEndTime' => ['description' => 'The time when ringing ends.'."\n" + ."\n" + .'> Outbound scenarios do not have a ring end time.', 'example' => '2020-10-02 22:33:09', 'type' => 'string', 'title' => ''], + 'PickUpTime' => ['description' => 'The time when the call is answered.', 'example' => '2020-10-02 22:33:09', 'type' => 'string', 'title' => ''], + 'EvaluationLevel' => ['description' => 'Satisfaction rating, indicated by star level. Valid values:'."\n" + ."\n" + .'- **2**: Two-star satisfaction'."\n" + .'- **3**: Three-star satisfaction'."\n" + .'- **4**: Four-star satisfaction'."\n" + .'- **5**: Five-star satisfaction'."\n" + ."\n" + .'> This field has no data in outbound scenarios or scenarios where the call was not answered.', 'example' => '4', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'RingContinueTime' => ['description' => 'Ringing duration, in seconds.'."\n" + ."\n" + .'> Outbound scenarios do not have ringing duration.', 'example' => '10', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'PassiveTransferIdType' => ['description' => 'The recipient of the transferred session. Valid values:'."\n" + .'- **1**: Agent ID.'."\n" + .'- **2**: Transferred phone number.'."\n" + ."\n" + .'> This field is null in non-transfer scenarios.', 'example' => '1', 'type' => 'string', 'title' => ''], + 'EvaluationScore' => ['description' => 'Satisfaction score. Valid values:'."\n" + .'- **1**: Very dissatisfied'."\n" + .'- **2**: Dissatisfied'."\n" + .'- **3**: Neutral'."\n" + .'- **4**: Satisfied'."\n" + .'- **5**: Very satisfied'."\n" + ."\n" + .'> This field has no data in outbound scenarios or scenarios where the call was not answered.', 'example' => '4', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'CreateTime' => ['description' => 'Call creation time.'."\n" + ."\n" + .'> - In outbound scenarios, this is the time when the outbound call was initiated.'."\n" + .'> - In inbound scenarios, this is the time when the call entered the ACC system.', 'example' => '2020-10-02 22:32:55', 'type' => 'string', 'title' => ''], + 'HangUpTime' => ['description' => 'Hang-up time. ', 'example' => '2020-10-02 22:33:46', 'type' => 'string', 'title' => ''], + 'GroupId' => ['description' => 'Skill group ID. '."\n" + ."\n" + .'> When CallType is **1**, outbound call scenarios do not include skill group information. ', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'InQueueTime' => ['description' => 'Time when the call entered the queue for assignment. '."\n" + ."\n" + .'> Outbound call scenarios do not include queue entry time. ', 'example' => '2020-10-02 22:32:55', 'type' => 'string', 'title' => ''], + 'RingStartTime' => ['description' => 'Ringing start time. '."\n" + ."\n" + .'> Outbound call scenarios do not include ringing start time. ', 'example' => '2020-10-02 22:32:59', 'type' => 'string', 'title' => ''], + 'CallContinueTime' => ['description' => 'Call duration, in seconds. '."\n" + ."\n" + .'> Unconnected calls do not include call duration. ', 'example' => '37', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'ActiveTransferId' => ['description' => 'Agent ID. '."\n" + ."\n" + .'> This field is null in non–change owner scenarios. ', 'example' => '12', 'type' => 'string', 'title' => ''], + 'HangUpRole' => ['description' => 'Party that hung up. Valid values: '."\n" + ."\n" + .'- **1**: System hung up '."\n" + .'- **2**: Customer hung up '."\n" + .'- **3**: Agent hung up '."\n" + .'- **null**: Unknown ', 'example' => '2', 'type' => 'string', 'title' => ''], + 'MemberName' => ['description' => 'Membership name.', 'example' => '匿名会员', 'type' => 'string', 'title' => ''], + 'Id' => ['description' => 'The GUID of the call detail record.', 'example' => 'acc1c58dab4a4dd280e3813c66', 'type' => 'string', 'title' => ''], + 'ServicerId' => ['description' => 'Agent ID. '."\n" + .'> In inbound scenarios, agent information is unavailable until the call is assigned to an agent.', 'example' => '555555', 'type' => 'string', 'title' => ''], + 'TrunkCall' => ['description' => 'Long-distance call.', 'example' => '1861111****', 'type' => 'string', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => '失败号码详情', 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'title' => '导入结果', 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 26,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"CallDetailRecord\\": [\\n {\\n \\"GroupName\\": \\"自动化技能组\\",\\n \\"CallResult\\": \\"normal\\",\\n \\"CalledNumber\\": \\"135615*****\\",\\n \\"Acid\\": \\"7719786\\",\\n \\"CallType\\": 1,\\n \\"QueueUpContinueTime\\": 4,\\n \\"PassiveTransferId\\": \\"12\\",\\n \\"CallingNumber\\": \\"0571773\\",\\n \\"MemberId\\": \\"7856876\\",\\n \\"ServicerName\\": \\"刘测试\\",\\n \\"OutQueueTime\\": \\"2020-10-02 22:32:59\\",\\n \\"RingEndTime\\": \\"2020-10-02 22:33:09\\",\\n \\"PickUpTime\\": \\"2020-10-02 22:33:09\\",\\n \\"EvaluationLevel\\": 4,\\n \\"RingContinueTime\\": 10,\\n \\"PassiveTransferIdType\\": \\"1\\",\\n \\"EvaluationScore\\": 4,\\n \\"CreateTime\\": \\"2020-10-02 22:32:55\\",\\n \\"HangUpTime\\": \\"2020-10-02 22:33:46\\",\\n \\"GroupId\\": 123456,\\n \\"InQueueTime\\": \\"2020-10-02 22:32:55\\",\\n \\"RingStartTime\\": \\"2020-10-02 22:32:59\\",\\n \\"CallContinueTime\\": 37,\\n \\"ActiveTransferId\\": \\"12\\",\\n \\"HangUpRole\\": \\"2\\",\\n \\"MemberName\\": \\"匿名会员\\",\\n \\"Id\\": \\"acc1c58dab4a4dd280e3813c66\\",\\n \\"ServicerId\\": \\"555555\\",\\n \\"TrunkCall\\": \\"1861111****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Batch query call details', + 'summary' => 'Query call details by instance ID. ', + 'description' => 'Call details include the total number of records, call result, agent name, call time, and other information.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No Rate Limiting.'."\n" + .'- API frequency: 80 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"SuccessCount\\": 7,\\n \\"FailInfo\\": [\\n {\\n \\"Msg\\": \\"号码格式异常\\",\\n \\"BizData\\": \\"xxxx\\",\\n \\"PhoneNum\\": \\"150****0000\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<InsertAiOutboundPhoneNumsResponse>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>\\n <TotalCount>10</TotalCount>\\n <SuccessCount>7</SuccessCount>\\n <FailInfo>\\n <BizData>xxxx</BizData>\\n <PhoneNum>150****0000</PhoneNum>\\n <Msg>号码格式异常</Msg>\\n </FailInfo>\\n </Data>\\n</InsertAiOutboundPhoneNumsResponse>","errorExample":""}]', - 'title' => 'InsertAiOutboundPhoneNums', + 'ramActions' => [], ], - 'GetAiOutboundTaskProgress' => [ - 'summary' => '智能外呼任务执行进度', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportOneTaskPhoneNumber' => [ + 'summary' => 'Imports a single phone number to a task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1231231212****', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The external ID. We recommend that you use a unique ID to ensure idempotency. The value cannot exceed 128 characters.', 'type' => 'string', 'required' => false, 'example' => '94ba739b-xxxx-ef91-335d-4be006c34899', 'title' => ''], ], [ - 'name' => 'BatchVersion', + 'name' => 'PhoneNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '任务批次（为空则查询任务下所有数据）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The phone number of the callee.', 'type' => 'string', 'required' => true, 'example' => '180******', 'title' => ''], + ], + [ + 'name' => 'Variables', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'A list of variables in a map.'."\n" + ."\n" + .'> The format of variables for an engine-based call task is as follows:'."\n" + .'>'."\n" + .'> - {"startWordParam.variable\\_key1":"variable\\_value1","promptParam.variable\\_key2":"variable\\_value2","bizParam.variable\\_key3":"variable\\_value3"}', 'type' => 'object', 'required' => false, 'example' => '{"变量key1":"变量值1","变量key2":"变量值2"}'."\n" + .'引擎呼叫任务示例值请看左侧描述', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'ok', - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access is denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'The returned data.', + 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '任务类型（2:预测式3:自动）', - 'type' => 'integer', - ], - 'TaskId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => '任务id', - 'type' => 'integer', - ], - 'CalloutProgress' => [ - 'description' => '', - 'properties' => [ - 'CallOutCount' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '外呼次数', - 'type' => 'integer', - ], - 'CallOutConnectCount' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'title' => '外呼接通次数（自动外呼特有）', - 'type' => 'integer', - ], - 'CallOutUserPickupCount' => [ - 'description' => '', - 'example' => '5', - 'format' => 'int32', - 'title' => '客户接起量（预测式外呼特有）', - 'type' => 'integer', - ], - 'CallOutUserPickupRate' => [ - 'description' => '', - 'example' => '0.5', - 'format' => 'float', - 'title' => '客户接起率（预测式外呼特有）', - 'type' => 'number', - ], - 'CallLossRate' => [ - 'description' => '', - 'example' => '0.01', - 'format' => 'float', - 'title' => '呼损率（预测式外呼特有）', - 'type' => 'number', - ], - 'CallOutConnectRate' => [ - 'description' => '', - 'example' => '0.5', - 'format' => 'float', - 'title' => '外呼接通次率（自动外呼特有）', - 'type' => 'number', - ], - 'CallOutServicerPickupCount' => [ - 'description' => '', - 'example' => '4', - 'format' => 'int32', - 'title' => '坐席接通量（预测式外呼特有）', - 'type' => 'integer', - ], - 'CallLossCount' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '呼损量（预测式外呼特有）', - 'type' => 'integer', - ], - 'CallOutServicerPickupRate' => [ - 'description' => '', - 'example' => '0.4', - 'format' => 'float', - 'title' => '坐席接通率（预测式外呼特有）', - 'type' => 'number', - ], - ], - 'title' => '外呼维度进展', - 'type' => 'object', - ], - 'TaskProgress' => [ - 'description' => '', - 'properties' => [ - 'FinishRate' => [ - 'description' => '', - 'example' => '0.20', - 'format' => 'float', - 'title' => '任务完成率', - 'type' => 'number', - ], - 'ConnectRate' => [ - 'description' => '', - 'example' => '0.2', - 'format' => 'float', - 'title' => '任务接通率（自动外呼特有）', - 'type' => 'number', - ], - 'WaitingCallCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '待呼叫任务数', - 'type' => 'integer', - ], - 'FinishCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '任务完成数', - 'type' => 'integer', - ], - 'ConnectCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '任务接通量（自动外呼特有）', - 'type' => 'integer', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '总任务数', - 'type' => 'integer', - ], - 'WaitingRecallCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '待重呼任务数', - 'type' => 'integer', - ], - 'TerminateCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '已终止任务数', - 'type' => 'integer', - ], - 'ServicerPickupCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '坐席接通数（预测式外呼特有）', - 'type' => 'integer', - ], - 'UserPickupCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '客户接起数（预测式外呼特有）', - 'type' => 'integer', - ], - 'CallingCount' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'title' => '呼叫中任务数', - 'type' => 'integer', - ], - 'ServicerPickupRate' => [ - 'description' => '', - 'example' => '0.2', - 'format' => 'float', - 'title' => '坐席接通率(预测式外呼特有）', - 'type' => 'number', - ], - 'UserPickupRate' => [ - 'description' => '', - 'example' => '0.2', - 'format' => 'float', - 'title' => '客户接起率（预测式外呼特有）', - 'type' => 'number', - ], - ], - 'title' => '任务维度进展', - 'type' => 'object', - ], + 'DetailId' => ['description' => 'The task detail ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '92304322323*****', 'title' => ''], ], - 'title' => '任务进展', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'ok', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The API call was successful.'."\n" + ."\n" + .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"ok\\",\\n \\"Data\\": {\\n \\"Type\\": 2,\\n \\"TaskId\\": 123456,\\n \\"CalloutProgress\\": {\\n \\"CallOutCount\\": 10,\\n \\"CallOutConnectCount\\": 5,\\n \\"CallOutUserPickupCount\\": 5,\\n \\"CallOutUserPickupRate\\": 0.5,\\n \\"CallLossRate\\": 0.01,\\n \\"CallOutConnectRate\\": 0.5,\\n \\"CallOutServicerPickupCount\\": 4,\\n \\"CallLossCount\\": 1,\\n \\"CallOutServicerPickupRate\\": 0.4\\n },\\n \\"TaskProgress\\": {\\n \\"FinishRate\\": 0.2,\\n \\"ConnectRate\\": 0.2,\\n \\"WaitingCallCount\\": 2,\\n \\"FinishCount\\": 2,\\n \\"ConnectCount\\": 2,\\n \\"TotalCount\\": 10,\\n \\"WaitingRecallCount\\": 2,\\n \\"TerminateCount\\": 2,\\n \\"ServicerPickupCount\\": 2,\\n \\"UserPickupCount\\": 2,\\n \\"CallingCount\\": 2,\\n \\"ServicerPickupRate\\": 0.2,\\n \\"UserPickupRate\\": 0.2\\n }\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAiOutboundTaskProgressResponse>\\n <RequestId>D9CB3933-9FE3-4870-BA8E-2BEE91B69D23</RequestId>\\n <Message>ok</Message>\\n <Code>ok</Code>\\n <Success>true</Success>\\n <Data>\\n <TaskId>123456</TaskId>\\n <Type>2</Type>\\n <TaskProgress>\\n <TotalCount>10</TotalCount>\\n <FinishCount>2</FinishCount>\\n <WaitingCallCount>2</WaitingCallCount>\\n <CallingCount>2</CallingCount>\\n <WaitingRecallCount>2</WaitingRecallCount>\\n <TerminateCount>2</TerminateCount>\\n <FinishRate>0.2</FinishRate>\\n <ServicerPickupCount>2</ServicerPickupCount>\\n <UserPickupCount>2</UserPickupCount>\\n <ServicerPickupRate>0.2</ServicerPickupRate>\\n <UserPickupRate>0.2</UserPickupRate>\\n <ConnectCount>2</ConnectCount>\\n <ConnectRate>0.2</ConnectRate>\\n </TaskProgress>\\n <CalloutProgress>\\n <CallOutCount>10</CallOutCount>\\n <CallOutConnectCount>5</CallOutConnectCount>\\n <CallOutConnectRate>0.5</CallOutConnectRate>\\n <CallLossCount>1</CallLossCount>\\n <CallLossRate>0.01</CallLossRate>\\n <CallOutServicerPickupCount>4</CallOutServicerPickupCount>\\n <CallOutUserPickupCount>5</CallOutUserPickupCount>\\n <CallOutServicerPickupRate>0.4</CallOutServicerPickupRate>\\n <CallOutUserPickupRate>0.5</CallOutUserPickupRate>\\n </CalloutProgress>\\n </Data>\\n</GetAiOutboundTaskProgressResponse>","errorExample":""}]', - 'title' => 'GetAiOutboundTaskProgress', - ], - 'StopAiOutboundTask' => [ - 'summary' => '手动暂停智能外呼任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Data\\": {\\n \\"DetailId\\": 0\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Import a single phone number data', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], - ], + 'ramActions' => [ [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'title' => 'Schema of Response', - 'type' => 'object', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StopAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</StopAiOutboundTaskResponse>","errorExample":""}]', - 'title' => 'StopAiOutboundTask', ], - 'TerminateAiOutboundTask' => [ - 'summary' => '终止智能外呼任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ImportTaskNumberDatas' => [ + 'summary' => 'Imports callee data for a call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '268865', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'OssFileName', 'in' => 'query', + 'schema' => ['description' => 'The OSS file path. This parameter is optional.'."\n" + ."\n" + .'> Importing data by specifying an OSS file path is not available because API calls currently support only the JSON data type.', 'type' => 'string', 'required' => false, 'example' => '123dsdfsdfsdf.xlsx', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the call task.', 'type' => 'string', 'required' => true, 'example' => '119181071278******', 'title' => ''], + ], + [ + 'name' => 'PhoneNumberList', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'example' => 'agent_****', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', + 'description' => 'If `DataType` is set to `JSON`, you must use this parameter to upload the data. You can import up to 1,000 records per request.', + 'type' => 'array', + 'items' => ['description' => 'The data structure is as follows:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "calleeNumber":"callee number",'."\n" + .' "outId":"A unique external transaction ID used to associate an external record with this call. This ID is returned in the receipt message. Maximum length: 128 characters.",'."\n" + .' "variable1":"value",'."\n" + .' "variable2":"value",// When using call variables, \'variable1\' and \'variable2\' are example keys, and \'value\' is the variable\'s value.'."\n" + .' }'."\n" + .'```'."\n" + ."\n" + .'> You can view the call variables on the [**communication agent management**](https://aiccs.console.aliyun.com/agent/customize) > **Details** > **call variable configuration** page.'."\n" + .'> Example of call variable configuration for an engine-based call task:'."\n" + .'> {'."\n" + .'> "calleeNumber": "callee number",'."\n" + .'> "outId": "",'."\n" + .'> "startWordParam.variable key1": "xxx",'."\n" + .'> "promptParam.variable key2": "xx",'."\n" + .'> "bizParam.variable key3": "xx"'."\n" + .'> }', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "calleeNumber": "0534556****",'."\n" + .' "outId": "CFC2F07E-F763-7C48-1A32-6EFFB6EA344E",'."\n" + .' "name": "Tom",'."\n" + .' "age": "18"'."\n" + .'}'."\n" + .'引擎通话任务通话变量配置示例请看描述中说明', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskId', + 'name' => 'DataType', 'in' => 'query', 'schema' => [ - 'description' => '', - 'example' => '1763****', - 'format' => 'int64', + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'- EXCEL'."\n" + ."\n" + .'- JSON'."\n" + ."\n\n" + .' ><notice>'."\n" + ."\n" + .' API calls currently support only the JSON data type.'."\n" + ."\n" + .' ></notice>', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'title' => '任务id', - 'type' => 'integer', + 'example' => 'JSON', + 'enum' => ['EXCEL', 'JSON'], + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'title' => 'Schema of Response', 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CFC2F07E-F763-7C48-1A32-6EFFB6EA344E', 'title' => ''], + 'Data' => ['description' => 'The import batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123497836486******'."\n", 'title' => ''], + 'Code' => ['description' => 'The request status code. `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request succeeded.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<TerminateAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</TerminateAiOutboundTaskResponse>","errorExample":""}]', - 'title' => 'TerminateAiOutboundTask', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CFC2F07E-F763-7C48-1A32-6EFFB6EA344E\\",\\n \\"Data\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Import Callee Data', + 'description' => '- You can import callee data by calling this operation. Alternatively, go to the **call task management** page, click **Import Callee Data**, download the template, and then upload your file.'."\n" + ."\n" + .'- This API operation currently supports only the JSON data type for importing callee data.'."\n" + ."\n" + .'- Ensure that you have created a call task before you call this operation.'."\n" + ."\n" + .'- To create a call task, go to the **call task management** page and click **Create Call Task**, or call the [CreateAiCallTask](~~2926796~~) operation.', + 'changeSet' => [ + ['createdAt' => '2026-02-02T07:39:07.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-02-02T07:38:45.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2026-02-02T07:38:42.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportTaskNumberDatas'], + ], + ], + 'ramActions' => [], ], - 'GetAiOutboundTaskList' => [ - 'summary' => '智能外呼任务列表查询', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InsertAiOutboundPhoneNums' => [ + 'summary' => 'Import outbound call callee numbers based on the instance ID and job ID. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_****', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => true, - 'title' => '任务类型(2:预测式外呼，3:自动外呼)', - 'type' => 'integer', - ], - ], - [ - 'name' => 'CreateTimeStart', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'required' => false, - 'title' => '任务创建起始时间戳（毫秒）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CreateTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1617761765000', - 'format' => 'int64', - 'required' => false, - 'title' => '任务创建截止时间戳（毫秒）', - 'type' => 'integer', - ], - ], - [ - 'name' => 'Status', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The job ID. '."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response. ', 'example' => '123', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'PageSize', + 'name' => 'BatchVersion', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '50', - 'minimum' => '1', - 'required' => true, - 'title' => '分页大小(<=50)', - 'type' => 'integer', - ], + 'schema' => ['description' => 'The batch version number of the job. '."\n" + ."\n" + .'> If this parameter is not specified, numbers are imported into the default batch. ', 'example' => '2', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'CurrentPage', + 'name' => 'Details', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'minimum' => '1', + 'description' => 'Number details. '."\n" + .'> A maximum of 30 entries are allowed. ', + 'items' => [ + 'description' => 'Number details. ', + 'properties' => [ + 'BizData' => ['description' => 'Custom business information. ', 'example' => 'xxxx', 'required' => false, 'title' => '', 'type' => 'string'], + 'PhoneNum' => ['description' => 'The callee number for outbound calls. ', 'example' => '150****0000', 'required' => false, 'title' => '', 'type' => 'string'], + ], + 'required' => false, + 'type' => 'object', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'title' => '查询第几页', - 'type' => 'integer', - ], - ], - [ - 'name' => 'SearchKey', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1763****', - 'required' => false, - 'title' => '过滤条件：匹配任务ID或者模糊匹配任务名', - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], @@ -18175,174 +12097,68 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => '请求id', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Import result. ', 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '分页大小', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '当前页数', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => '数据总量', - 'type' => 'integer', - ], - 'List' => [ - 'description' => '', + 'TotalCount' => ['description' => 'Total number of imported entries. ', 'example' => '10', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'SuccessCount' => ['description' => 'Number of successfully imported entries. ', 'example' => '7', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'FailInfo' => [ + 'description' => 'Details of failed numbers. ', 'items' => [ - 'description' => '', + 'description' => 'Details of failed numbers. ', 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'title' => '任务状态（0:未开始,1:进行中,2:系统暂停,3:手动暂停,4:已完成,5:已终止）', - 'type' => 'integer', - ], - 'FinishRate' => [ - 'description' => '', - 'example' => '0.7', - 'format' => 'float', - 'title' => '任务完成率', - 'type' => 'number', - ], - 'StatusDesc' => [ - 'description' => '', - 'example' => '未开始', - 'title' => '任务状态描述', - 'type' => 'string', - ], - 'HandlerId' => [ - 'description' => '', - 'example' => '2468****', - 'format' => 'int64', - 'title' => '技能组id（预测式）或者ivr id（自动外呼）', - 'type' => 'integer', - ], - 'ConcurrentRate' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '自动外呼的并发', - 'type' => 'integer', - ], - 'TotalCount' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'title' => '任务总量', - 'type' => 'integer', - ], - 'TaskId' => [ - 'description' => '', - 'example' => '1763****', - 'format' => 'int64', - 'title' => '任务id', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => '', - 'title' => '任务描述', - 'type' => 'string', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '1615083365000', - 'format' => 'int64', - 'title' => '任务创建时间毫秒时间戳', - 'type' => 'integer', - ], - 'FinishCount' => [ - 'description' => '', - 'example' => '70', - 'format' => 'int32', - 'title' => '任务已完成量', - 'type' => 'integer', - ], - 'HandlerName' => [ - 'description' => '', - 'example' => '热线技能组', - 'title' => '技能组名称或ivr名称', - 'type' => 'string', - ], - 'Name' => [ - 'description' => '', - 'example' => 'xx外呼任务', - 'title' => '任务名称', - 'type' => 'string', - ], + 'Msg' => ['description' => 'Description of the failure reason. ', 'example' => '号码格式异常', 'title' => '', 'type' => 'string'], + 'BizData' => ['description' => 'Custom business information.', 'example' => 'xxxx', 'title' => '', 'type' => 'string'], + 'PhoneNum' => ['description' => 'The callee number for outbound calls. ', 'example' => '150****0000', 'title' => '', 'type' => 'string'], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => '任务信息', + 'title' => '', 'type' => 'array', - ], - 'HasNextPage' => [ - 'description' => '', - 'example' => 'false', - 'title' => '是否有下一页', - 'type' => 'boolean', + 'example' => '', ], ], - 'title' => '任务列表', + 'title' => '', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"SuccessCount\\": 7,\\n \\"FailInfo\\": [\\n {\\n \\"Msg\\": \\"号码格式异常\\",\\n \\"BizData\\": \\"xxxx\\",\\n \\"PhoneNum\\": \\"150****0000\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Import callee numbers for outbound calls ', + 'description' => '- After importing outbound call callee numbers, the outbound calling job can operate normally. '."\n" + .'- Before invoking this API, we recommend that you confirm the instance ID and job ID. For more information, see [Request Parameters](#api-detail-35). '."\n" + ."\n" + .'### Queries per second (QPS) limits '."\n" + .'- Per-user invocation frequency: 20 times/second. '."\n" + .'- API invocation frequency: 50 times/second. '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertAiOutboundPhoneNums'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 10,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"FinishRate\\": 0.7,\\n \\"StatusDesc\\": \\"未开始\\",\\n \\"HandlerId\\": 0,\\n \\"ConcurrentRate\\": 1,\\n \\"TotalCount\\": 100,\\n \\"TaskId\\": 0,\\n \\"Description\\": \\"房产销售\\",\\n \\"CreateTime\\": 1615083365000,\\n \\"FinishCount\\": 70,\\n \\"HandlerName\\": \\"热线技能组\\",\\n \\"Name\\": \\"xxxx外呼任务\\"\\n }\\n ],\\n \\"HasNextPage\\": false\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAiOutboundTaskListResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n <Data>\\n <PageSize>10</PageSize>\\n <HasNextPage>false</HasNextPage>\\n <TotalResults>10</TotalResults>\\n <CurrentPage>1</CurrentPage>\\n <List>\\n <Status>0</Status>\\n <StatusDesc>未开始</StatusDesc>\\n <Name>xxxx外呼任务</Name>\\n <Description>房产销售</Description>\\n <HandlerName>热线技能组</HandlerName>\\n <ConcurrentRate>1</ConcurrentRate>\\n <TotalCount>100</TotalCount>\\n <FinishCount>70</FinishCount>\\n <FinishRate>0.7</FinishRate>\\n <CreateTime>1615083365000</CreateTime>\\n </List>\\n </Data>\\n</GetAiOutboundTaskListResponse>","errorExample":""}]', - 'title' => 'GetAiOutboundTaskList', + 'ramActions' => [], ], - 'StartAiOutboundTask' => [ - 'summary' => '启动智能外呼任务', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InsertTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18350,353 +12166,254 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'OutboundTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_****', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'CallInfos', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1763****', - 'format' => 'int64', - 'required' => true, - 'title' => '任务id', - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'title' => 'Schema of Response', - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartAiOutboundTaskResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <Code>OK</Code>\\n <Success>true</Success>\\n</StartAiOutboundTaskResponse>","errorExample":""}]', - 'title' => 'StartAiOutboundTask', - ], - 'AddHotlineNumber' => [ - 'summary' => '新增热线号码', - 'methods' => [ - 'post', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', + ], + 'JoinThirdCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique customer request ID used for idempotency validation; can be generated using UUID', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'HotlineNumber', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '05710000****', - 'pattern' => '^\\d+$', - 'required' => true, - 'title' => '号码', - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID, visible in the Artificial Intelligence Cloud Call Service console', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'desc', - 'required' => true, - 'title' => '号码描述', - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent account name (agent logon name)', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EnableInbound', + 'name' => 'CallId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否用于入呼', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'acid from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'InboundFlowId', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'title' => '入呼ivr流程id', - 'type' => 'integer', - ], + 'schema' => ['description' => 'jobId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EnableOutbound', + 'name' => 'ConnectionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否用于外呼', - 'type' => 'boolean', - ], + 'schema' => ['description' => 'connId from WebSocket after an inbound call', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OutboundAllDepart', + 'name' => 'HoldConnectionId', 'in' => 'formData', + 'schema' => ['description' => 'holdConnId from WebSocket after an inbound call (only provided during two-step transfer)', 'docRequired' => true, 'example' => '0', 'required' => false, 'type' => 'string', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '外呼是否对所有部门生效', - 'type' => 'boolean', + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Fault description', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID, used to trail the cause of a fault', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Fault encoding', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Whether the API call succeeded', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add Third Party to Call', + 'summary' => 'Add a third party to the call.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListAgentBySkillGroupId' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnableInboundEvaluation', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否开启入呼满意度', - 'type' => 'boolean', - ], + 'AK' => [], ], [ - 'name' => 'EnableOutboundEvaluation', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否开启外呼满意度', - 'type' => 'boolean', - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'EvaluationLevel', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => false, - 'title' => '满意度等级', - 'type' => 'integer', - 'enum' => [ - '2', - '3', - '4', - '5', - ], - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique ID for the Customer request. It is used for idempotency validation and can be generated using a UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OutboundRangeList', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'GroupIdList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1234', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '生效技能组列表（部门123下）', - 'type' => 'array', - ], - 'DepartmentId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'title' => '生效部门id', - 'type' => 'integer', - ], - ], - 'required' => false, - 'type' => 'object', - ], - 'required' => false, - 'title' => '外呼生效范围', - 'type' => 'array', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The skill group ID. '."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID.', 'docRequired' => true, 'example' => '666666', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE339D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'title' => '错误信息', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'title' => 'http状态码', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Agent information.', + 'items' => [ + 'description' => 'Data information.', + 'properties' => [ + 'Status' => ['description' => 'Agent status. Only agents with a Normal status can perform Business Activities. Valid values:'."\n" + .'- **0**: Normal'."\n" + .'- **1**: Frozen'."\n" + .'- **2**: Deleted', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID to which the agent belongs. This corresponds to the instance ID provided in the input parameter.', 'example' => '0', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'DisplayName' => ['description' => 'Display name of the agent.', 'example' => '刘测试', 'type' => 'string', 'title' => ''], + 'AgentId' => ['description' => 'Agent ID.', 'example' => '666666', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'AccountName' => ['description' => 'Account name of the agent, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'example' => 'username@example.com', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<AddHotlineNumberResponse>\\n <RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>OK</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</AddHotlineNumberResponse>","errorExample":""}]', - 'title' => ' AddHotlineNumber', + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"TenantId\\": 0,\\n \\"DisplayName\\": \\"刘测试\\",\\n \\"AgentId\\": 666666,\\n \\"AccountName\\": \\"username@example.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Agent Information under a Skill Group', + 'summary' => 'Query the agent list in the Cloud Customer Service System by AICCS instance ID and skill group ID.', + 'description' => '- Before invoking this API, confirm the AICCS instance information and skill group information. For guidance on how to obtain these details, refer to the description of [Request Parameters](#api-detail-35).'."\n" + .'- If an agent is not assigned to any skill group, you can invoke [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) to query the agent information.'."\n" + ."\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'DeleteHotlineNumber' => [ - 'summary' => '删除热线号码', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAiccsRobot' => [ + 'summary' => 'Retrieve the list of robot scripts, including robot type, robot name, robot ID, associated business, and industry information.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], - ], - [ - 'name' => 'HotlineNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '05710000****', - 'pattern' => '^\\d+$', - 'required' => true, - 'title' => '号码', - 'type' => 'string', - ], + 'name' => 'RobotName', + 'in' => 'query', + 'schema' => ['description' => 'The robot name. You can view the robot name in the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface.', 'example' => '测试机器人', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -18704,289 +12421,190 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1F', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'title' => '错误信息', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'title' => 'http状态码', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', + 'RequestId' => ['description' => 'Request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Robot scripts.', + 'items' => [ + 'description' => 'List of scripts.', + 'properties' => [ + 'RobotType' => ['description' => 'Robot type.', 'example' => 'CUSTOM', 'type' => 'string', 'title' => ''], + 'AtSence' => ['description' => 'Associated business.', 'example' => '新房销售', 'type' => 'string', 'title' => ''], + 'AtProfession' => ['description' => 'Associated industry.', 'example' => '房地产', 'type' => 'string', 'title' => ''], + 'RobotName' => ['description' => 'Robot name.', 'example' => '测试机器人', 'type' => 'string', 'title' => ''], + 'Id' => ['description' => 'Robot ID.', 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request Succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation Succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1F\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"OK\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<DeleteHotlineNumberResponse>\\n <RequestId>98B032F5-6473-4EAC-8BA8-C28993513A1F</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>OK</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</DeleteHotlineNumberResponse>","errorExample":""}]', - 'title' => 'DeleteHotlineNumber', - ], - 'ResetHotlineNumber' => [ - 'summary' => '重置热线号码', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"RobotType\\": \\"CUSTOM\\",\\n \\"AtSence\\": \\"新房销售\\",\\n \\"AtProfession\\": \\"房地产\\",\\n \\"RobotName\\": \\"测试机器人\\",\\n \\"Id\\": 0\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve Script List', + 'description' => '- Before invoking this API, ensure that you already have scripts that have passed the Review.'."\n" + ."\n" + .'- If you do not have any scripts that have passed the Review, add a script and submit it for Review in the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface first.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No Rate Limiting.'."\n" + .'- API frequency: 500 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttle will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListAiccsRobot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListAvailableTts' => [ + 'summary' => 'Lists the system and custom TTS voices available for large model-based outbound calls.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '273987', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], - ], - [ - 'name' => 'HotlineNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '0571********', - 'pattern' => '^\\d+$', - 'required' => true, - 'title' => '号码', - 'type' => 'string', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'desc', - 'required' => true, - 'title' => '号码描述', - 'type' => 'string', - ], - ], - [ - 'name' => 'EnableInbound', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否用于入呼', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'InboundFlowId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'title' => '入呼ivr流程id', - 'type' => 'integer', - ], - ], - [ - 'name' => 'EnableOutbound', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否用于外呼', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'OutboundAllDepart', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '外呼是否对所有部门生效', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'EnableInboundEvaluation', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否开启入呼满意度', - 'type' => 'boolean', - ], - ], - [ - 'name' => 'EnableOutboundEvaluation', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => true, - 'title' => '是否开启外呼满意度', - 'type' => 'boolean', - ], + 'name' => 'TtsVoiceCode', + 'in' => 'query', + 'schema' => ['description' => 'The voice code for a custom voice. You can find it on the [Custom Voice](https://aiccs.console.aliyun.com/engine/voiceprint) page.', 'type' => 'string', 'required' => false, 'example' => 'V9A******', 'title' => ''], ], [ - 'name' => 'EvaluationLevel', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'required' => false, - 'title' => '满意度等级', - 'type' => 'integer', - 'enum' => [ - '2', - '3', - '4', - '5', - ], - ], + 'name' => 'VoiceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the TTS voice. Valid values:'."\n" + ."\n" + .'`SYSTEM`: system voice.'."\n" + ."\n" + .'`COSYCLONE`: cloned voice.'."\n" + ."\n" + .'`BL-CUSTOM`: premium custom voice.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], ], - [ - 'name' => 'OutboundRangeList', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'GroupIdList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denial. The system returns this parameter only if a RAM permission check fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID generated by Alibaba Cloud. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '5EBAEBE6-0E77-5E1F-99E4-7B20512F22222'], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Data' => [ + 'title' => '', + 'description' => 'A list of available TTS voices.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a TTS voice.', + 'type' => 'object', + 'properties' => [ + 'TtsVoiceName' => ['description' => 'The name of the TTS voice.', 'type' => 'string', 'example' => '龙小夏', 'title' => ''], + 'TtsEngine' => ['description' => 'The voice engine. Valid values:'."\n" + ."\n" + .'- CosyVoice: A custom voice or a system voice.'."\n" + ."\n" + .'- Volcano: A Doubao voice.', 'type' => 'string', 'example' => 'CosyVoice', 'title' => ''], + 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'example' => 'cosyvoice-v2-*********-*******', 'title' => ''], + 'TtsAuditionFileUrl' => ['description' => 'The URL for the voice audition file.', 'type' => 'string', 'example' => 'https://*******/longxiaoxia.mp3', 'title' => ''], + 'TtsVoiceCode' => ['description' => 'The voice code.', 'type' => 'string', 'example' => 'V9A******'."\n", 'title' => ''], + 'VoiceType' => ['description' => 'The type of the TTS voice. Valid values:'."\n" + ."\n" + .'`SYSTEM`: system voice.'."\n" + ."\n" + .'`COSYCLONE`: cloned voice.'."\n" + ."\n" + .'`BL-CUSTOM`: premium custom voice.', 'type' => 'string', 'example' => 'COSYCLONE', 'title' => ''], ], - 'required' => false, - 'title' => '生效技能组列表（部门123下）', - 'type' => 'array', - ], - 'DepartmentId' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'required' => false, - 'title' => '生效部门id', - 'type' => 'integer', + 'enumValueTitles' => [], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'required' => false, - 'type' => 'object', + 'Code' => ['description' => 'The status code. `OK` indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'required' => false, - 'title' => '外呼生效范围', - 'type' => 'array', + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxx', - 'title' => '错误信息', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'title' => 'http状态码', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"5EBAEBE6-0E77-5E1F-99E4-7B20512F22222\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TtsVoiceName\\": \\"龙小夏\\",\\n \\"TtsEngine\\": \\"CosyVoice\\",\\n \\"TtsStyle\\": \\"cosyvoice-v2-*********-*******\\",\\n \\"TtsAuditionFileUrl\\": \\"https://*******/longxiaoxia.mp3\\",\\n \\"TtsVoiceCode\\": \\"V9A******\\\\n\\",\\n \\"VoiceType\\": \\"COSYCLONE\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain the List of TTS Voices Supported by the LLM Calling Feature ', + 'description' => 'If you have not created and published any custom voices on the [Custom Voice](https://aiccs.console.aliyun.com/engine/voiceprint) page, the operation returns only system voices.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListAvailableTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'title' => 'Schema of Response', - 'type' => 'object', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"<ResetHotlineNumberResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>xxx</Message>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ResetHotlineNumberResponse>","errorExample":""}]', - 'title' => 'ResetHotlineNumber', ], - 'QueryHotlineNumber' => [ - 'summary' => '查询热线号码配置', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListChatRecordDetail' => [ + 'summary' => 'Invoke ListChatRecordDetail to query online session details by time period. ', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18994,92 +12612,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ - 'name' => 'CurrentPage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'minimum' => '1', - 'required' => true, - 'title' => '当前页码', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. ', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'PageSize', + 'name' => 'CloseTimeEnd', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '20', - 'minimum' => '1', - 'required' => true, - 'title' => '每页大小', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Right boundary of the time range for session end time. Format: UNIX timestamp in milliseconds. ', 'example' => '1614582000000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'HotlineNumber', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571****2211', - 'required' => false, - 'title' => '号码（支持模糊查询）', - 'type' => 'string', - ], + 'schema' => ['description' => 'Current page number. Default value: 1. ', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer', 'default' => '1'], ], [ - 'name' => 'DepartmentId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2256****', - 'format' => 'int64', - 'required' => false, - 'title' => '部门id（技能组分组）', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Page size. Default value: **500**. ', 'example' => '100', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer', 'default' => '500'], ], [ - 'name' => 'GroupIds', + 'name' => 'CloseTimeStart', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '["6083****","6084****"]', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => '技能组列表', - 'type' => 'array', - ], + 'schema' => ['description' => 'Left boundary of the time range for session end time. Format: UNIX timestamp in milliseconds. ', 'example' => '1614578400000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -19087,200 +12650,94 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE339D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'title' => '错误信息', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', + 'ResultData' => [ + 'description' => 'Returned data. ', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'example' => '123', - 'format' => 'int64', - 'title' => '数据总量', - 'type' => 'integer', - ], - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'title' => '每页大小', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '当前页面', - 'type' => 'integer', - ], - 'HotlineNumList' => [ - 'description' => '', + 'OnePageSize' => ['description' => 'Page size ', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages. ', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CurrentPage' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'TotalResults' => ['description' => 'Total number of records. ', 'example' => '100', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => [ + 'description' => 'Query result data. ', 'items' => [ - 'description' => '', + 'description' => 'Session list data object. ', 'properties' => [ - 'FlowId' => [ - 'description' => '', - 'example' => '12', - 'format' => 'int64', - 'title' => '入呼流程id', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => '测试', - 'title' => '号码描述', - 'type' => 'string', - ], - 'OutboundEnabled' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否用于外呼', - 'type' => 'boolean', - ], - 'CalloutAllDepartment' => [ - 'description' => '', - 'example' => 'true', - 'title' => '外呼针对所有部门生效', - 'type' => 'boolean', - ], - 'FlowName' => [ - 'description' => '', - 'example' => '测试流程', - 'title' => '入呼流程名称', - 'type' => 'string', - ], - 'CalloutRangeList' => [ - 'description' => '', + 'ServicerName' => ['description' => 'Servicer Account ', 'example' => '123@123.com', 'type' => 'string', 'title' => ''], + 'EndTime' => ['description' => 'Online End Time. ', 'example' => '1614578410000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'StartTime' => ['description' => 'The start time of the online session.', 'example' => '1614578400000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'MessageList' => [ + 'description' => 'A list of detailed online session information.', 'items' => [ - 'description' => '', + 'description' => 'Session detail.', 'properties' => [ - 'GroupDOList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'GroupName' => [ - 'description' => '', - 'example' => '', - 'title' => '技能组名称', - 'type' => 'string', - ], - 'GroupId' => [ - 'description' => '', - 'example' => '6083****', - 'format' => 'int64', - 'title' => '技能组id', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], - 'title' => '技能组列表', - 'type' => 'array', - ], - 'DepartmentName' => [ - 'description' => '', - 'example' => '', - 'title' => '部门名称', - 'type' => 'string', - ], - 'DepartmentId' => [ - 'description' => '', - 'example' => '2256****', - 'format' => 'int64', - 'title' => '部门id', - 'type' => 'integer', - ], + 'SenderName' => ['description' => 'The account that sent the message.', 'example' => 'account1', 'type' => 'string', 'title' => ''], + 'Content' => ['description' => 'The content of the sent message.', 'example' => '你好', 'type' => 'string', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the message was sent.', 'example' => '1614578400000', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'SenderType' => ['description' => 'The type of sender. Valid values:'."\n" + .'- **1**: Membership'."\n" + .'- **2**: Customer service', 'example' => '2', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'MsgType' => ['description' => 'Message type. ', 'example' => 'MSG', 'type' => 'string', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => '外呼生效列表', + 'title' => '', 'type' => 'array', - ], - 'HotlineNumber' => [ - 'description' => '', - 'example' => '0571****2211', - 'title' => '号码', - 'type' => 'string', - ], - 'EvaluationStatus' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'title' => '满意度状态', - 'type' => 'integer', - ], - 'Sp' => [ - 'description' => '', - 'example' => '电信', - 'title' => '运营商', - 'type' => 'string', - ], - 'Location' => [ - 'description' => '', - 'example' => '浙江杭州', - 'title' => '归属地', - 'type' => 'string', - ], - 'InBoundEnabled' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否用于入呼', - 'type' => 'boolean', + 'example' => '', ], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => '号码列表', 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'title' => '返回结果数据', + 'title' => 'data', 'type' => 'object', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否成功', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'xxxx', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], - 'title' => 'Schema of Response', + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"HotlineNumList\\": [\\n {\\n \\"FlowId\\": 12,\\n \\"Description\\": \\"测试\\",\\n \\"OutboundEnabled\\": true,\\n \\"CalloutAllDepartment\\": true,\\n \\"FlowName\\": \\"测试流程\\",\\n \\"CalloutRangeList\\": [\\n {\\n \\"GroupDOList\\": [\\n {\\n \\"GroupName\\": \\"技能组A\\",\\n \\"GroupId\\": 0\\n }\\n ],\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 0\\n }\\n ],\\n \\"HotlineNumber\\": \\"0571****2211\\",\\n \\"EvaluationStatus\\": 0,\\n \\"Sp\\": \\"电信\\",\\n \\"Location\\": \\"浙江杭州\\",\\n \\"InBoundEnabled\\": true\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryHotlineNumberResponse>\\n <RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>xxx</Message>\\n <Data>\\n <TotalCount>123</TotalCount>\\n <CurrentPage>1</CurrentPage>\\n <PageSize>10</PageSize>\\n <HotlineNumList>\\n <HotlineNumber>05710000****</HotlineNumber>\\n <Description>测试</Description>\\n <Location>浙江杭州</Location>\\n <Sp>电信</Sp>\\n <InBoundEnabled>true</InBoundEnabled>\\n <FlowId>12</FlowId>\\n <FlowName>测试流程</FlowName>\\n <OutboundEnabled>true</OutboundEnabled>\\n <CalloutAllDepartment>true</CalloutAllDepartment>\\n <CalloutRangeList>\\n <DepartmentId>123456</DepartmentId>\\n <DepartmentName>部门A</DepartmentName>\\n <GroupDOList>\\n <GroupId>123456</GroupId>\\n <GroupName>技能组A</GroupName>\\n </GroupDOList>\\n </CalloutRangeList>\\n <EvaluationStatus>0</EvaluationStatus>\\n </HotlineNumList>\\n </Data>\\n</QueryHotlineNumberResponse>","errorExample":""}]', - 'title' => ' QueryHotlineNumber', - ], - 'GetConfigNumList' => [ - 'summary' => '获取热线配置号码列表', - 'methods' => [ - 'get', + 'errorCodes' => [ + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 10,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"MessageList\\": [\\n {\\n \\"SenderName\\": \\"account1\\",\\n \\"Content\\": \\"你好\\",\\n \\"CreateTime\\": 1614578400000,\\n \\"SenderType\\": 2,\\n \\"MsgType\\": \\"MSG\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query online session details by time range ', + 'description' => 'This API queries information about completed online sessions within a specified time range, including session content. The query rules are as follows: '."\n" + .'- The maximum time span for the query is 1 Day. '."\n" + .'- If only the query End Time is provided, the query Start Time is set to 1 hour before the End Time. '."\n" + .'- If only the query Start Time is provided, the End Time is set to 1 hour after the Start Time. '."\n" + .'- If neither time is provided, the End Time defaults to the current time, and the Start Time is set to 1 hour before the End Time. '."\n" + .'- If both times are provided but the time span exceeds 1 Day, an abnormal response is returned. ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChatRecordDetail'], + ], ], + 'ramActions' => [], + ], + 'ListDialog' => [ + 'summary' => 'Query Intelligent Contact Bot conversation records.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19288,47 +12745,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique job ID of the robot outbound call task. You can view it in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or obtain it by invoking the [CreateTask](~~223556~~) API. ', 'example' => '12****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'DepartmentId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '12345', - 'format' => 'int64', - 'required' => false, - 'title' => '部门ID', - 'type' => 'integer', - ], - ], - [ - 'name' => 'AccountName', + 'name' => 'Called', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123@123.com', - 'required' => false, - 'title' => '账号名称', - 'type' => 'string', - ], + 'schema' => ['description' => 'The called number. You can view the called number in the [**Task Management**](https://aiccs.console.aliyun.com/job/list) > **Details** interface or retrieve it by invoking the [ListTaskDetail](~~2718009~~) API. The **Called** parameter in the API response is the called number. ', 'example' => '130****0000', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -19336,82 +12763,84 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE339D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '错误信息', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Status code description.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Call interaction content.'."\n", 'items' => [ - 'description' => '', - 'example' => '0:"057****890" 1:"057****506" 2:"057****507" 3:"057****417" 4:"057****090" 5:"057****888"', - 'type' => 'string', + 'description' => '1', + 'properties' => [ + 'Role' => ['description' => 'Speaking role. Valid values:'."\n" + ."\n" + .'- robot: Bot.'."\n" + ."\n" + .'- user: User.'."\n", 'example' => 'robot', 'type' => 'string', 'title' => ''], + 'Content' => ['description' => 'Dialogue content.'."\n", 'example' => '您好', 'type' => 'string', 'title' => ''], + 'NodeType' => ['description' => 'File Type.'."\n", 'example' => 'normal', 'type' => 'string', 'title' => ''], + 'Time' => ['description' => 'Start Time. UNIX timestamp format, in milliseconds.'."\n", 'example' => '1619763900718', 'type' => 'string', 'title' => ''], + 'Tag' => ['description' => 'Intent label.'."\n", 'example' => '肯定', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => '号码列表', 'type' => 'array', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified department does not exist.', - 'errorCode' => 'Department.NotFound', - ], - ], - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"您好\\",\\n \\"NodeType\\": \\"normal\\",\\n \\"Time\\": \\"1619763900718\\",\\n \\"Tag\\": \\"肯定\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query conversation records ', + 'description' => '- You can invoke this API to query Intelligent Contact Bot conversation records, or view them in the **Task Management** > **Details** > **View Conversation Records** interface.'."\n" + ."\n" + .'- Before invoking this API, ensure that your created Intelligent Contact Bot calling job has successfully connected to at least one phone number.'."\n" + ."\n" + .'- If you do not have an existing Intelligent Contact Bot calling job, you can create and start a job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface, or use the [CreateTask](~~2718003~~) and [StartTask](~~2718005~~) APIs to create and start a job.'."\n" + ."\n\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListDialog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": [\\n \\"0:\\\\\\"057****890\\\\\\" 1:\\\\\\"057****506\\\\\\" 2:\\\\\\"057****507\\\\\\" 3:\\\\\\"057****417\\\\\\" 4:\\\\\\"057****090\\\\\\" 5:\\\\\\"057****888\\\\\\"\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetConfigNumListResponse>\\n <RequestId>EE339D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>Success</Code>\\n <Message>xxxx</Message>\\n <Data>0:\\"057****890\\" 1:\\"057****506\\" 2:\\"057****507\\" 3:\\"057****417\\" 4:\\"057****090\\" 5:\\"057****888\\"</Data>\\n</GetConfigNumListResponse>","errorExample":""}]', - 'title' => 'GetConfigNumList', ], - 'AnswerCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListHotlineRecord' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19420,80 +12849,24 @@ 'BearerToken' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', - 'required' => false, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'Session ID. This corresponds to the acid in WebSocket after an inbound call.', 'docRequired' => true, 'example' => '100365558', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -19501,170 +12874,168 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Hotline session information.', + 'items' => [ + 'description' => 'Hotline session recording information.', + 'properties' => [ + 'ConnectionId' => ['description' => 'Connection ID.', 'example' => '100365548', 'type' => 'string', 'title' => ''], + 'EndTime' => ['description' => 'Recording end UNIX timestamp. Unit: milliseconds.', 'example' => '16128694810', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CallId' => ['description' => 'Session ID. This corresponds to the acid in WebSocket after an inbound call.', 'example' => '100365558', 'type' => 'string', 'title' => ''], + 'StartTime' => ['description' => 'Recording start UNIX timestamp. Unit: milliseconds.', 'example' => '16128694110', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Url' => ['description' => 'Recording file URL.', 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A return value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"ConnectionId\\": \\"100365548\\",\\n \\"EndTime\\": 16128694810,\\n \\"CallId\\": \\"100365558\\",\\n \\"StartTime\\": 16128694110,\\n \\"Url\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Hotline Recording List', + 'summary' => 'Invoke ListHotlineRecord to query the hotline recording list by hotline session ID.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AnswerCallResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</AnswerCallResponse>","errorExample":""}]', - 'title' => 'AnswerCall', + 'ramActions' => [], ], - 'FinishHotlineService' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListHotlineRecordDetail' => [ + 'summary' => 'Query the list of hotline details by time period.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'A unique ID for the customer request. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console. ', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CloseTimeEnd', + 'in' => 'query', + 'schema' => ['description' => 'The start time when the hotline call ends. The value is a UNIX timestamp in milliseconds.', 'example' => '1614582000000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'Current page number. Default value: **1**. ', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. Default value: **100**. ', 'example' => '100', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer', 'default' => '100'], + ], + [ + 'name' => 'CloseTimeStart', + 'in' => 'query', + 'schema' => ['description' => 'The end time when the hotline call ends. The value is a UNIX timestamp in milliseconds.', 'example' => '1614578400000', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'ResultData' => [ + 'description' => 'Returned data.', + 'properties' => [ + 'OnePageSize' => ['description' => 'Page size.', 'example' => '100', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages.', 'example' => '10', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CurrentPage' => ['description' => 'Current page.', 'example' => '1', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'TotalResults' => ['description' => 'Total number of records.', 'example' => '945', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => [ + 'description' => 'Query result data.', + 'items' => [ + 'description' => 'Session list data object.', + 'properties' => [ + 'ServicerName' => ['description' => 'Servicer Account.', 'example' => '123@123.com', 'type' => 'string', 'title' => ''], + 'EndTime' => ['description' => 'Hotline End Time.', 'example' => '1614578410000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'StartTime' => ['description' => 'Start Time of the hotline call. ', 'example' => '1614578400000', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'OssUrl' => ['description' => 'OSS URL of the hotline call recording. ', 'example' => 'http://xxx.xxxxx/xx.wav', 'title' => '', 'type' => 'string'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'title' => 'data', + 'type' => 'object', + 'example' => '', ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'xxxx', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code. ', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded. ', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 100,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 945,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"OssUrl\\": \\"http://xxx.xxxxx/xx.wav\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Hotline Details List ', + 'description' => 'This API queries detailed hotline information within a specified time range, including hotline call information. The query rules are as follows: '."\n" + .'- The maximum time span for the query is 1 Day. '."\n" + .'- If only the query End Time is provided, the query Start Time is set to 1 hour before the End Time. '."\n" + .'- If only the query Start Time is provided, the End Time is set to 1 hour after the Start Time. '."\n" + .'- If neither time is provided, the End Time defaults to the current time, and the Start Time is set to 1 hour before the End Time. '."\n" + .'- If both times are provided but the time span exceeds 1 Day, an abnormal result is returned. '."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineRecordDetail'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<FinishHotlineServiceResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</FinishHotlineServiceResponse>","errorExample":""}]', - 'title' => 'FinishHotlineService', + 'ramActions' => [], ], - 'GetNumLocation' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListOutboundPhoneNumber' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19675,104 +13046,79 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - ], + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PhoneNum', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1360987****', - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'result', - 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'xxxx', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'EE338D98-9BD3-4413-B165', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Outbound caller phone numbers.', + 'items' => ['description' => 'Outbound caller phone number.', 'example' => '{906****}', 'type' => 'string', 'title' => ''], + 'type' => 'array', + 'title' => '', 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Success', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"杭州\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"{906****}\\"\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Outbound Number Information', + 'summary' => 'Obtain the outbound caller phone numbers for a specified agent based on the instance ID and agent account name.', + 'description' => '### Queries per second (QPS) limit'."\n" + .'- Per-user API call frequency: No rate limiting.'."\n" + .'- API frequency: 100 calls per second.'."\n" + ."\n" + .'> If the total calls from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetRtcToken' => [ - 'summary' => '获取RtcToken', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRobotCallDialog' => [ + 'summary' => 'Query Intelligent Contact Robot call records.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -19780,35 +13126,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique call ID. You can invoke the [RobotCall](~~2717996~~) API and check the **Data** field in the response to obtain it.', 'example' => '12516551****^11195613****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'CreateTime', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'username@example.com', - 'required' => true, - 'title' => '账号名称', - 'type' => 'string', - ], + 'schema' => ['description' => 'Creation Time. Format: YYYY-MM-DD hh:mm:ss. The time must be precise. You can invoke the [RobotCall](~~2717996~~) API and view the **date** parameter in the **Response Header** of the response to obtain this value. ', 'example' => '2021-05-20 00:00:00', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -19816,368 +13144,348 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Successful', - 'title' => '错误信息', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '{"cleansession":true,"clientId":"GID_VOIP@@@ClientId_2000000001271771_100685295007","conferenceTopic":"cs_alicom_voip_conference_pre","dataTopic":"alicom_voip_data_pre","host":"mqtt-cn-4590mdhb901.mqtt.aliyuncs.com","meetingEventKeepAliveInterval":0,"phoneTopic":"alicom_voip_phone","port":0,"reconnectTimeout":2000,"registerTime":0,"sdkClientPort":8883,"serverId":"GID_VOIP@@@MTEuMjIuMTQ1Ljgy","sgwServerTopic":"alicom_voip_server_pre","tlsport":443,"tokenData":"LzMT+XLFl5s/YWJ/MlDz4t/Lq5HC1iGU1P28HAMaxYzmBSHQsWXgdISJ1ZJ+2cxaU0jwYsoyG8Q8cCIbLZTwwaFHf7gc7pPXbJGYgJWUr5ooKsoHaVvvG34cww7W8woWE1OsmZGFDODvooOIjF1CZSorVrR8OwRdprW99yqhMhkJKh7r5f3HfiQgoJWL8b3A85RrRGCSP057skgQ5rIqVAlx7jDFrOTdLtz+krken8qYvpaVBO9wRfFyWQLvxAgNJNx3Oql/hpzc2o3+xbKGTA/P2siLn6Nee1FYk5ClpXcnvfSTM4BAauuWR+oES10VblKEKTU5R/pfjXj3UKOlZ1+OdGO93WA16BR/l1uRb3cOLqya5pjWM+oSmo0sOR7B0ATLz6K1xA0Pc+p6Mu8hZl+OdGO93WA1kj1L0h9Z6CAZG4ol/BNdIg9z6noy7yFmX450Y73dYDWSPUvSH1noIBkbiiX8E10iT0a6ypXxupQdyyrhh8j1yw6otqnw5AT5Tj5VsVWVfflXeZ8nPt1ydXC9nWeHX7K80O6vtOU9M8Qn5VrhkP0F1umbOoYs3NfM+WYZIQx4pkViQo6qqkxgbEg1l6oHJbmOVzrxYRrDTIxqgE/pb0YVJQ==","useTLS":false,"username":"LTAI27GqAW1VrcQA"}', - 'properties' => [ - 'RtcId' => [ - 'description' => '', - 'example' => '200000000*******', - 'title' => 'rtcId', - 'type' => 'string', - ], - 'Token' => [ - 'description' => '', - 'enumValueTitles' => [], - 'example' => '{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}', - 'title' => 'token信息', - 'type' => 'string', - ], - 'AccountName' => [ - 'description' => '', - 'example' => '139000000', - 'title' => '账号名', - 'type' => 'string', + 'description' => 'Conversation records.', + 'items' => [ + 'description' => 'List of conversation records.', + 'properties' => [ + 'Role' => ['description' => 'Role in the conversation content.', 'example' => 'robot', 'type' => 'string', 'title' => ''], + 'Content' => ['description' => 'Script content.', 'example' => '我是某某的客服，看您之前在我们家找过工作，做个回访，现在工作怎么样？', 'type' => 'string', 'title' => ''], + 'NodeType' => ['description' => 'File Type.', 'example' => '开场白', 'type' => 'string', 'title' => ''], + 'Time' => ['description' => 'Start Time. UNIX timestamp in milliseconds.', 'example' => '1621483557000', 'type' => 'string', 'title' => ''], + 'Tag' => ['description' => 'Intent label.', 'example' => '拒绝', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'title' => 'data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否成功', - 'type' => 'boolean', + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Role\\": \\"robot\\",\\n \\"Content\\": \\"我是某某的客服，看您之前在我们家找过工作，做个回访，现在工作怎么样？\\",\\n \\"NodeType\\": \\"开场白\\",\\n \\"Time\\": \\"1621483557000\\",\\n \\"Tag\\": \\"拒绝\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Call Records', + 'description' => '- Before invoking this API, ensure that you have already initiated an outbound job using the Intelligent Contact Robot.'."\n" + ."\n" + .'- If you have not yet initiated an outbound job using the Intelligent Contact Robot, you can invoke the [RobotCall](~~2717996~~) API to start one.'."\n" + ."\n\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-20T06:39:10.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"RtcId\\": \\"200000000*******\\",\\n \\"Token\\": \\"{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_****”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}\\",\\n \\"AccountName\\": \\"139000000\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetRtcTokenResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>Successful</Message>\\n <Data>\\n <Token>{“cleansession”:true,”clientId”:”GID_VOIP@@@ClientId_2000000000000009_100648480015”,”conferenceTopic”:”cs_alicom_voip_conference”,”host”:”mqtt-cn-4590mdhb901.mqtt.aliyuncs.com”,”meetingEventKeepAliveInterval”:0,”phoneTopic”:”alicom_voip_phone”,”port”:0,”reconnectTimeout”:2000,”registerTime”:0,”sdkClientPort”:8883,”serverId”:”GID_VOIP@@@MTEuMTMuMTM2LjExOA==”,”sgwServerTopic”:”alicom_voip_server_pre”,”tlsport”:443,”tokenData”:”abcdef”,”useTLS”:false}</Token>\\n <RtcId>2000000001271771</RtcId>\\n <AccountName>150****5678</AccountName>\\n </Data>\\n</GetRtcTokenResponse>","errorExample":""}]', - ], - 'HangupCall' => [ - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotCallDialog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRobotNode' => [ + 'summary' => 'Retrieves the list of robot node information based on the robot ID, which is the script ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'RobotId', + 'in' => 'query', + 'schema' => ['description' => 'The robot ID, which is the script ID. '."\n" + .'You can obtain it in the <b>outbound robot</b> > <b>Script Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => '100002674****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'Ok', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'List of robot nodes.', + 'items' => [ + 'description' => 'List of robot nodes.', + 'properties' => [ + 'ProcessName' => ['description' => 'Flow name.', 'example' => '开场白', 'type' => 'string', 'title' => ''], + 'ModelName' => ['description' => 'Model name.', 'example' => '模型一', 'type' => 'string', 'title' => ''], + 'IsOutput' => ['description' => 'Whether it is an output. Valid values:'."\n" + ."\n" + .'- **1**: Yes.'."\n" + .'- **0**: No.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'NodeName' => ['description' => 'Node name.', 'example' => '理财', 'type' => 'string', 'title' => ''], + 'NodeIdentifier' => ['description' => 'Output ID.', 'example' => '12****', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'Ok', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"Ok\\",\\n \\"Data\\": [\\n {\\n \\"ProcessName\\": \\"开场白\\",\\n \\"ModelName\\": \\"模型一\\",\\n \\"IsOutput\\": 1,\\n \\"NodeName\\": \\"理财\\",\\n \\"NodeIdentifier\\": \\"12****\\"\\n }\\n ],\\n \\"Code\\": \\"Ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve the list of robot node information', + 'description' => '- Robot node information includes flow name, model name, node name, whether it is an output, and output ID. '."\n" + .'- Before invoking this API, you can confirm the robot ID (that is, the script ID) by following the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-10-21T13:04:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListRobotParams' => [ + 'summary' => 'Queries the list of robot parameters by robot ID, which is also the script ID.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'ConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'RobotId', + 'in' => 'query', + 'schema' => ['description' => 'Robot ID, which is also the script ID. You can view it on the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface or obtain it by using the [ListAiccsRobot](~~2717998~~) API.', 'example' => '12****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'RequestId' => ['description' => 'Request ID.', 'example' => 'FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Parameter information.', + 'items' => [ + 'description' => 'List of parameters.', + 'properties' => [ + 'IsEmpty' => ['description' => 'Indicates whether the parameter is required. Valid values:'."\n" + ."\n" + .'- 0: Not required.'."\n" + ."\n" + .'- 1: Required.', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'ParamCode' => ['description' => 'Parameter ID.', 'example' => '1', 'type' => 'string', 'title' => ''], + 'ParamName' => ['description' => 'Parameter name.', 'example' => '名称', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'Status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<HangupCallResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</HangupCallResponse>","errorExample":""}]', - 'title' => 'HangupCall', - ], - 'ListHotlineRecord' => [ - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FF67D4D5-4E90-1DF5-BB8F-060BBFAD72DB\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"IsEmpty\\": 0,\\n \\"ParamCode\\": \\"1\\",\\n \\"ParamName\\": \\"名称\\"\\n }\\n ],\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Robot Parameter List', + 'description' => '- Before invoking this API, ensure that you have already added input parameters for the robot.'."\n" + ."\n" + .'- If your robot does not have any input parameters, go to the [**Script Management**](https://aiccs.console.aliyun.com/patter/list) > **Configuration** > **Input and Output Parameters** interface and click to add an input parameter.'."\n" + ."\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttle will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotParams', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListRoles' => [ + 'summary' => 'Invoke ListRoles to obtain the list of all roles under a tenant.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => 'clientToken', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '100365558', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'Message' => ['description' => 'Status code description.', 'example' => 'xxxx', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], 'Data' => [ - 'description' => '', + 'description' => 'Role information.', 'items' => [ - 'description' => '', + 'description' => 'Data list.', 'properties' => [ - 'ConnectionId' => [ - 'description' => '', - 'example' => '100365548', - 'type' => 'string', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '16128694810', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CallId' => [ - 'description' => '', - 'example' => '100365558', - 'type' => 'string', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '16128694110', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Url' => [ - 'description' => '', - 'example' => 'http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com', - 'type' => 'string', - ], + 'RoleGroupId' => ['description' => 'ID of the group to which the role belongs.', 'example' => '0', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'BuId' => ['description' => 'Tenant ID.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Description' => ['description' => 'Role description.', 'example' => 'Admin', 'title' => '', 'type' => 'string'], + 'CreateTime' => ['description' => 'Creation Time. Format: <i>yyyy-MM-dd</i>T<i>HH:mm:ss</i>Z (UTC).', 'example' => '2020-01-03T20:25:33Z', 'title' => '', 'type' => 'string'], + 'Title' => ['description' => 'Role name.', 'example' => '企业管理员', 'title' => '', 'type' => 'string'], + 'RoleGroupName' => ['description' => 'Name of the role group to which the role belongs.', 'example' => '角色组名称', 'title' => '', 'type' => 'string'], + 'RoleId' => ['description' => 'Role ID.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'Role code.', 'example' => 'admin', 'title' => '', 'type' => 'string'], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'title' => 'data', 'type' => 'array', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], + 'title' => 'result', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"RoleGroupId\\": 0,\\n \\"BuId\\": 1,\\n \\"Description\\": \\"Admin\\",\\n \\"CreateTime\\": \\"2020-01-03T20:25:33Z\\",\\n \\"Title\\": \\"企业管理员\\",\\n \\"RoleGroupName\\": \\"角色组名称\\",\\n \\"RoleId\\": 1,\\n \\"Code\\": \\"admin\\"\\n }\\n ],\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'List Roles', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"ConnectionId\\": \\"100365548\\",\\n \\"EndTime\\": 16128694810,\\n \\"CallId\\": \\"100365558\\",\\n \\"StartTime\\": 16128694110,\\n \\"Url\\": \\"http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListHotlineRecordResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>\\n <EndTime>16128694810</EndTime>\\n <StartTime>16128694110</StartTime>\\n <ConnectionId>100365548</ConnectionId>\\n <CallId>100365558</CallId>\\n <Url>http://aliccrec-shvpc.oss-cn-shanghai.aliyuncs.com</Url>\\n</Data>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</ListHotlineRecordResponse>","errorExample":""}]', - 'title' => 'ListHotlineRecord', + 'ramActions' => [], ], - 'ListOutboundPhoneNumber' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSkillGroup' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20188,45 +13496,31 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'ChannelType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The skill group channel type. Valid values:'."\n" + .'- **0**: Returns all skill groups.'."\n" + .'- **1**: Voice skill group.'."\n" + .'- **2**: Chat skill group.'."\n" + .'- **3**: Chat and voice skill group.'."\n" + .'- **4**: Ticket skill group.'."\n" + .'- **5**: Voice and ticket skill group.'."\n" + .'- **6**: Chat and ticket skill group.'."\n" + .'- **7**: Chat, voice, and ticket skill group.'."\n", 'example' => '2', 'format' => 'int32', 'maximum' => '7', 'minimum' => '0', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ @@ -20234,157 +13528,111 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'Skill group information.', 'items' => [ - 'description' => '', - 'example' => '{906****}', - 'type' => 'string', + 'description' => 'Data information.', + 'properties' => [ + 'Description' => ['description' => 'Skill group description.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'DisplayName' => ['description' => 'Display name of the skill group.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'SkillGroupId' => ['description' => 'Skill group ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelType' => ['description' => 'Channel type of the skill group.', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Name' => ['description' => 'Name of the skill group.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], 'type' => 'array', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"{906****}\\"\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListOutboundPhoneNumberResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>{906****}</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</ListOutboundPhoneNumberResponse>","errorExample":""}]', - 'title' => 'ListOutboundPhoneNumber', + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2,\\n \\"Name\\": \\"自动化技能组\\"\\n }\\n ],\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Skill Groups', + 'summary' => 'Query skill groups in the Cloud Customer Service System by instance ID and skill group channel type.', + 'description' => '### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'MakeDoubleCall' => [ - 'summary' => '移动端发起呼叫', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTask' => [ + 'summary' => 'Perform a paged query to retrieve the list of Intelligent Contact Robot call jobs. The response includes the total number of jobs and job details.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'agent_***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The job name. You can view the names of created jobs in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.', 'example' => '任务测试', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'AccountName', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '12345', - 'required' => true, - 'title' => '账号名称', - 'type' => 'string', - ], + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'ServicerPhone', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '150****1234', - 'required' => false, - 'title' => '坐席手机号（需要通过坐席手机呼叫才需要填写）', - 'type' => 'string', - ], + 'schema' => ['description' => 'The number of items per page. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'MemberPhone', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1502123****', - 'required' => true, - 'title' => '用户手机号', - 'type' => 'string', - ], + 'schema' => ['description' => 'Job Status. Valid values:'."\n" + ."\n" + .'- **INIT**: Not started.'."\n" + .'- **RELEASE**: Parsing.'."\n" + .'- **RUNNING**: Executing.'."\n" + .'- **STOP**: Paused manually.'."\n" + .'- **SYSTEM_STOP**: Paused by the system.'."\n" + .'- **READY**: Pending execution.'."\n" + .'- **CANCEL**: Stopped manually.'."\n" + .'- **SYSTEM_CANCEL**: Stopped by the system.'."\n" + .'- **DONE**: Completed.', 'example' => 'STOP', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OutboundCallNumber', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571000****', - 'required' => true, - 'title' => '外呼主叫号码', - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique job ID of the robot calling job. You can view it in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or obtain it by using the [CreateTask](~~223556~~) API.', 'example' => '12****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'BizData', + 'name' => 'RobotName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '{"bizId": 123456}', - 'required' => false, - 'title' => '业务携带数据（JsonString）', - 'type' => 'string', - ], + 'schema' => ['description' => 'The robot name, which is the script name. You can view the names of scripts that have passed Review in the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface.', 'example' => '机器人', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -20392,1318 +13640,939 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'Successful', - 'title' => '错误信息', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', + 'description' => 'List of job data.', 'properties' => [ - 'Acid' => [ - 'description' => '', - 'example' => '68255155365620598', - 'title' => '会话id', - 'type' => 'string', + 'PageSize' => ['description' => 'Number of entries per page.', 'example' => '20', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Total' => ['description' => 'Total number of jobs.', 'example' => '50', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'PageNo' => ['description' => 'Current page number.', 'example' => '1', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Record' => [ + 'description' => 'List of job information.', + 'items' => [ + 'description' => 'Job information.', + 'properties' => [ + 'Status' => ['description' => 'Task Status.', 'example' => 'RELEASE', 'type' => 'string', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time of the job. Format: UNIX timestamp in milliseconds.', 'example' => '1618477232000', 'type' => 'string', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of processed calls.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'FireTime' => ['description' => 'Job start time. The value is a UNIX timestamp in milliseconds.', 'example' => '1618477232000', 'type' => 'string', 'title' => ''], + 'TaskName' => ['description' => 'Task Name.', 'example' => '测试任务', 'type' => 'string', 'title' => ''], + 'RobotId' => ['description' => 'The ID of the specified robot, which is the script ID.', 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'RobotName' => ['description' => 'Robot Name.', 'example' => '机器人', 'type' => 'string', 'title' => ''], + 'Id' => ['description' => 'The unique job ID for the robot calling task.', 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CompleteCount' => ['description' => 'Number of completed calls.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - 'title' => '返回数据', 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '调用是否成功', - 'type' => 'boolean', - ], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"68255155365620598\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<MakeDoubleCallResponse>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Success>true</Success>\\n<Code>200</Code>\\n<Message>Successful</Message>\\n<Data>\\n <Acid>68255155365620598</Acid>\\n</Data>\\n</MakeDoubleCallResponse>","errorExample":""}]', - 'title' => 'MakeDoubleCall', - ], - 'SendHotlineHeartBeat' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'BearerToken' => [], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 50,\\n \\"PageNo\\": 1,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"RELEASE\\",\\n \\"GmtCreate\\": \\"1618477232000\\",\\n \\"TotalCount\\": 1,\\n \\"FireTime\\": \\"1618477232000\\",\\n \\"TaskName\\": \\"测试任务\\",\\n \\"RobotId\\": 0,\\n \\"RobotName\\": \\"机器人\\",\\n \\"Id\\": 0,\\n \\"CompleteCount\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'List Jobs', + 'description' => '- You can use this API to obtain the list of Intelligent Contact Robot call jobs, or retrieve the job list from the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.'."\n" + ."\n" + .'- If you have not created any Intelligent Contact Robot call jobs, you can click **Create Job** in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or create a job by invoking the [CreateTask](~~2718003~~) API.'."\n" + ."\n" + .'- The optional parameters of this API serve as Filter Conditions for the Intelligent Contact Robot call job list. If these parameters are not specified, the API queries all jobs.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No Rate Limiting.'."\n" + .'- API frequency: 500 calls per second.'."\n" + ."\n" + .'> If the combined invocations from multiple users exceed the API frequency limit, throttle will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'Token', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0079e7a845e373****', - 'required' => true, - 'type' => 'string', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'type' => 'object', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendHotlineHeartBeatResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</SendHotlineHeartBeatResponse>","errorExample":""}]', - 'title' => 'SendHotlineHeartBeat', ], - 'StartCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListTaskDetail' => [ + 'summary' => 'Obtain the detail information of Intelligent Contact Robot call jobs.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'StatusCode', + 'in' => 'query', + 'schema' => ['description' => 'The call status code. For more information, see [Call Status Codes](~~112804~~) in Voice Service.', 'example' => '200100', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Detail status. Valid values:'."\n" + .'- **SUCCESS**: The outbound call succeeded.'."\n" + .'- **FAIL**: The outbound call failed.'."\n" + .'- **INIT**: The outbound call has not been made.', 'example' => 'SUCCESS', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'Caller', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '906****', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'Callee', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1360987****', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'Called', + 'in' => 'query', + 'schema' => ['description' => 'The callee number. You can view the callee number on the **Detail** interface of [**Task Management**](https://aiccs.console.aliyun.com/job/list).', 'example' => '186****0000', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID. You can view the job ID on the [Task Management](https://aiccs.console.aliyun.com/job/list) page or obtain it by using the [ListTask](~~2718008~~) API.', 'example' => '12****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The detail ID. You can view the detail ID on the **Detail** interface of [**Task Management**](https://aiccs.console.aliyun.com/job/list).', 'example' => '12****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => [ + 'description' => 'Detailed job information.'."\n", + 'properties' => [ + 'PageSize' => ['description' => 'Current page number.'."\n", 'example' => '1', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Total' => ['description' => 'Total number of jobs.'."\n", 'example' => '50', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'PageNo' => ['description' => 'Number of items per page.'."\n", 'example' => '20', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Record' => [ + 'description' => 'List of job information.'."\n", + 'items' => [ + 'description' => '1', + 'properties' => [ + 'Status' => ['description' => 'Detail status.'."\n", 'example' => 'SUCCESS', 'type' => 'string', 'title' => ''], + 'Called' => ['description' => 'Called number.', 'example' => '186****0000', 'type' => 'string', 'title' => ''], + 'EndTime' => ['description' => 'End time.', 'example' => '2021-05-20 00:03:00', 'type' => 'string', 'title' => ''], + 'StartTime' => ['description' => 'Start Time.', 'example' => '2021-05-20 00:00:00', 'type' => 'string', 'title' => ''], + 'Duration' => ['description' => 'Call duration. Unit: seconds.', 'example' => '30', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'StatusCode' => ['description' => 'Call status code.', 'example' => '200100', 'type' => 'string', 'title' => ''], + 'StatusCodeDesc' => ['description' => 'Call status code description.', 'example' => '呼叫成功', 'type' => 'string', 'title' => ''], + 'Direction' => ['description' => 'Hang-up direction. Valid values:'."\n" + ."\n" + .'- **User**.'."\n" + .'- **Machine**.', 'example' => '用户', 'type' => 'string', 'title' => ''], + 'RetryCurTimes' => ['description' => 'Current retry count.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Caller' => ['description' => 'Calling number.', 'example' => '136****0000', 'type' => 'string', 'title' => ''], + 'Id' => ['description' => 'Record ID.', 'example' => '12****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'RetryTimes' => ['description' => 'Retry Count.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Tags' => ['description' => 'Intent tags.', 'example' => '肯定', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 1,\\n \\"Total\\": 50,\\n \\"PageNo\\": 20,\\n \\"Record\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Called\\": \\"186****0000\\",\\n \\"EndTime\\": \\"2021-05-20 00:03:00\\",\\n \\"StartTime\\": \\"2021-05-20 00:00:00\\",\\n \\"Duration\\": 30,\\n \\"StatusCode\\": \\"200100\\",\\n \\"StatusCodeDesc\\": \\"呼叫成功\\",\\n \\"Direction\\": \\"用户\\",\\n \\"RetryCurTimes\\": 1,\\n \\"Caller\\": \\"136****0000\\",\\n \\"Id\\": 0,\\n \\"RetryTimes\\": 1,\\n \\"Tags\\": \\"肯定\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Obtain Job Detail Information', + 'description' => '- You can invoke this API to obtain the detail information of Intelligent Contact Robot call jobs. Alternatively, you can view this information in the **Detail** interface under [**Task Management**](https://aiccs.console.aliyun.com/job/list).'."\n" + ."\n" + .'- Before invoking this API, ensure that you have created an Intelligent Contact Robot and successfully started a job.'."\n" + ."\n" + .'- If you do not have any successfully created Intelligent Contact Robot call jobs, you can create and start a job in the [Task Management](https://aiccs.console.aliyun.com/job/list) interface, or use the [CreateTask](~~2718003~~) and [StartTask](~~2718005~~) APIs to create and start a job.'."\n" + ."\n" + .'- The optional parameters in this API serve as filter conditions for the detail information of Intelligent Contact Robot call jobs. If these parameters are not specified, all job details will be queried.'."\n" + ."\n" + .'### queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListTaskDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartCallResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</StartCallResponse>","errorExample":""}]', - 'title' => 'StartCall', ], - 'StartHotlineService' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'LlmFullDuplexCallOperate' => [ + 'summary' => 'Performs full-duplex large language model operations.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREaiccsC7PL62'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'js sdk中自动生成的鉴权token', - 'type' => 'string', - ], + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The unique receipt ID of the call. You can obtain this ID by calling the LlmSmartCallFullDuplex operation.', 'type' => 'string', 'required' => true, 'example' => '示例值'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'Command', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The action command: play / flush / hangup / sendDtmf.', 'type' => 'string', 'required' => true, 'example' => '示例值'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'username@example.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The extension parameter, a JSON character string. The metric description for each command:', 'type' => 'string', 'required' => false, 'example' => '示例值示例值'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'example' => '0079e7a845e37334ff', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This parameter is returned only when RAM authentication fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '示例值示例值示例值'], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => '示例值示例值示例值'], + 'Data' => ['description' => 'The result of the command execution. Valid values:'."\n" + .'- **true**: The command was executed.'."\n" + .'- **false**: The command failed to be executed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'Code' => ['description' => 'The status code. A value of Success indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => '示例值示例值'], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Full-duplex call control', + 'description' => '- This operation can be called only during an intelligent outbound call. When you call this operation, set the **CallId** request parameter to the unique receipt ID of the ongoing call.'."\n" + .'- **CallId** is the **CallId** parameter returned by the [LlmSmartCallFullDuplex](~~2718012~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:LlmFullDuplexCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0079e7a845e373****\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartHotlineServiceResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>0079e7a845e37334ff</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</StartHotlineServiceResponse>","errorExample":""}]', - 'title' => 'StartHotlineService', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'SuspendHotlineService' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'LlmSmartCall' => [ + 'summary' => 'Intelligent outbound call based on an LLM.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'chargeType' => 'paid', + 'abilityTreeCode' => '256802', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Called number that receives the intelligent outbound call.', 'type' => 'string', 'required' => true, 'example' => '137****0000', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CallerNumber', + 'in' => 'query', + 'schema' => ['description' => 'Caller number. This parameter is required and supports only numbers from the Chinese mainland. View available numbers in the Voice Service [Number Management](https://dyvmsnext.console.aliyun.com/number/list/normal) interface.', 'type' => 'string', 'required' => false, 'example' => '132****2054', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '5', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'name' => 'ApplicationCode', + 'in' => 'query', + 'schema' => ['description' => 'LLM application code. View it in the [Application Management](https://aiccs.console.aliyun.com/engine/llmApp) interface.', 'type' => 'string', 'required' => true, 'example' => 'F32******', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartHotlineServiceResponse>\\n<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>\\n</StartHotlineServiceResponse>","errorExample":""}]', - 'title' => 'SuspendHotlineService', - ], - 'AddOuterAccount' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'OuterAccountId', + 'name' => 'StartWordParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1212', - 'required' => true, - 'type' => 'string', - ], + 'style' => 'json', + 'schema' => ['description' => 'Start-word variables. Go to the [LLM Application Management](https://aiccs.console.aliyun.com/engine/llmApp) interface and click Details to view the start-word variables of your created LLM application.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "name": "小明",'."\n" + .' "address": "浙江省杭州市"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'OuterAccountType', + 'name' => 'PromptParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'alipay', - 'required' => true, - 'type' => 'string', - ], + 'style' => 'json', + 'schema' => ['description' => 'Prompt variable. Go to the [Application Management](https://aiccs.console.aliyun.com/engine/llmApp) interface and click Details to view the prompt variables you created.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "style": "温柔"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'OuterAccountName', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'An ID reserved for the caller. This ID will be returned to the caller through a receipt message. Length: 1–15 bytes.', 'type' => 'string', 'required' => false, 'example' => '222356****', 'maxLength' => 32, 'title' => ''], ], [ - 'name' => 'Avatar', + 'name' => 'BizParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'http://****', - 'required' => false, - 'type' => 'string', - ], + 'style' => 'json', + 'schema' => ['description' => 'Business parameters. These parameters are passed to the customer model when invoking the customer model.', 'type' => 'object', 'required' => false, 'example' => 'biz_params = {'."\n" + .' "user_prompt_params": "{\\"city\\":\\"北京\\"}"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'RealName', + 'name' => 'Extension', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The extension number of the X number, up to 5 digits.'."\n" + ."\n" + .'><notice>Fill this field only in AXN extension mode. If no extension number exists, do not fill it.></notice>', 'type' => 'string', 'maxLength' => 5, 'required' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'OuterDepartmentId', + 'name' => 'SessionTimeout', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '3', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Maximum call duration. The call is automatically disconnected after timeout. Unit: seconds.'."\n" + .'>'."\n" + .'>- Maximum value: 3600 s.'."\n" + .'>- Minimum value: 600 s.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '300', 'example' => '1200', 'title' => ''], ], [ - 'name' => 'OuterGroupIds', + 'name' => 'TtsVoiceCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '["222","333","444"]', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The voice code used for TTS playback.'."\n" + .'> '."\n" + .'> - If no value is set, the voice code configured in the LLM application is used by default.'."\n" + .'> - You can use the [ListAvailableTts](~~2926668~~) API to view all available voice codes.', 'type' => 'string', 'required' => false, 'example' => 'V65******', 'title' => ''], ], [ - 'name' => 'Ext', + 'name' => 'TtsSpeed', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Voice speed during TTS playback.'."\n" + ."\n" + .'> '."\n" + .'> - Value range: -200 to 200. Default value is 0.'."\n" + .'> - If this parameter is not set, the voice speed configured in the LLM application is used by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], ], [ - 'name' => 'OuterDepartmentType', + 'name' => 'TtsVolume', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'type_invalid', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The volume for TTS playback.'."\n" + .'> '."\n" + .'> - Value range: 0–100. Default value is 0.'."\n" + .'> - If no value is set, the volume configured in the LLM application is used by default.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'OuterGroupType', + 'name' => 'CustomerLineCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'mybank', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Customer-provided ingest endpoint encoding.'."\n" + ."\n" + .'> '."\n" + .'> - If you use your own line, contact Alibaba Cloud support to enable this feature.'."\n" + .'> - The line encoding is provided by Alibaba Cloud support. Do not set this parameter if you do not have one.', 'type' => 'string', 'required' => false, 'example' => 'SELF_xxxxx_A_NET', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '123456', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'D6A51251-F7C4-596A-9F45-3C3219A5450D'], + 'Code' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'Description of the status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CallId' => ['description' => 'Unique receipt ID for this call.', 'type' => 'string', 'example' => '125165515***^11195613****', 'title' => ''], ], - 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorCode' => 'ModelStatus.Invalid', 'errorMessage' => 'Model state invalid.', 'description' => 'Invalid model state.'], + ['errorCode' => 'MissingParameter.CallerNumber', 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'description' => 'The request required parameter "CallerNumber" was not provided ".'], + ['errorCode' => 'InvalidParameter.ApplicationCode', 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', 'description' => 'The parameter ApplicationCode is invalid.'], + ['errorCode' => 'ModelNotExist', 'errorMessage' => 'The model does not exist.', 'description' => 'The model does not exist.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'LLM-based Intelligent Calling', + 'description' => '- Each API invocation supports adding only one called number. If you have multiple called numbers, invoke the API multiple times.'."\n" + ."\n" + .'- Before initiating an intelligent call based on an LLM, ensure that you have created an LLM application in the [Application Management](https://aiccs.console.aliyun.com/engine/llmApp) interface and have successfully requested a real number in the Voice Service [Number Management](https://dyvmsnext.console.aliyun.com/number/list/normal) interface.', + 'changeSet' => [ + ['createdAt' => '2025-07-10T15:15:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-30T06:27:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-05-13T02:43:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-18T03:54:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-14T05:49:07.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddOuterAccountResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>123456</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddOuterAccountResponse>","errorExample":""}]', - 'title' => 'AddOuterAccount', - ], - 'AiccsSmartCall' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LlmSmartCall'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D6A51251-F7C4-596A-9F45-3C3219A5450D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"125165515***^11195613****\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'LlmSmartCallEncrypt' => [ + 'summary' => 'Initiates a smart call to an encrypted number using a large language model.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', + 'chargeType' => 'paid', + 'abilityTreeCode' => '270332', + 'abilityTreeNodes' => ['FEATUREaiccs6AMUI3'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'EncryptCalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['description' => 'The encrypted called number.', 'type' => 'string', 'required' => true, 'example' => '140*********243', 'title' => ''], ], [ - 'name' => 'CalledShowNumber', + 'name' => 'PromptParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571000****', - 'required' => true, - 'type' => 'string', - ], + 'style' => 'json', + 'schema' => ['description' => 'Parameters for the large language model\'s prompt.', 'type' => 'object', 'required' => false, 'example' => '{"prompt":"推荐一部电影"}', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'StartWordParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1862222****', - 'required' => true, - 'type' => 'string', - ], + 'style' => 'json', + 'schema' => ['description' => 'Parameters for the large language model\'s opening statement.', 'type' => 'object', 'required' => false, 'example' => '{"name":"小明","address":"浙江省杭州市"}', 'title' => ''], ], [ - 'name' => 'VoiceCode', + 'name' => 'ApplicationCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The application code for the large language model.', 'type' => 'string', 'required' => true, 'example' => 'AD******45', 'title' => ''], ], [ - 'name' => 'OutId', + 'name' => 'CallerNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '222356****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The caller number.', 'type' => 'string', 'required' => true, 'example' => '132******65', 'title' => ''], ], [ - 'name' => 'PlayTimes', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'A user-defined ID for the outbound call.', 'type' => 'string', 'required' => false, 'example' => 'dsa*******sad', 'title' => ''], ], - [ - 'name' => 'Volume', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about the access denied error.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'A description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F92F9749-105E-518F-8B08-CF16EF36A0E2', 'title' => ''], + 'Data' => [ + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'CallId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '149******206', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Code' => ['description' => 'The request status code. A value of \'ok\' indicates that the request succeeded.', 'type' => 'string', 'example' => 'ok', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The API call was successful.'."\n" + ."\n" + .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F92F9749-105E-518F-8B08-CF16EF36A0E2\\",\\n \\"Data\\": {\\n \\"CallId\\": \\"149******206\\"\\n },\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'LLM-based Intelligent Outbound Calling with Encrypted Numbers', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Speed', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCallEncrypt', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'LlmSmartCallFullDuplex' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AsrModelId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', - 'required' => false, - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '256802', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'AsrBaseId', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'customer_service_8k', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => '**CalledNumber** '."\n" + .'The phone number that receives the intelligent outbound call.', 'type' => 'string', 'required' => true, 'example' => '1234567890', 'title' => ''], ], [ - 'name' => 'AsrAlsAmId', + 'name' => 'CallerNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '23387****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => '**CallerNumber** '."\n" + .'The calling number.', 'type' => 'string', 'required' => true, 'example' => '0987654321', 'title' => ''], ], [ - 'name' => 'AsrVocabularyId', + 'name' => 'ApplicationCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '6689****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => '**ApplicationCode** '."\n" + .'The application code.', 'type' => 'string', 'required' => true, 'example' => 'app123', 'title' => ''], ], [ - 'name' => 'RecordFlag', + 'name' => 'StartWordParam', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'style' => 'json', + 'schema' => ['description' => '**StartWordParam** '."\n" + .'The opening greeting variable. Format: JSON. Specify the variable name and parameter, for example, `{"custom":"XXX"}`.', 'type' => 'object', 'required' => false, 'example' => '{\\"tailnumber\\":\\"7898\\",\\"platformOrder\\":\\"\\",\\"signatory\\":\\"客户\\"}', 'title' => ''], ], [ - 'name' => 'PauseTime', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '800', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => '**OutId** '."\n" + .'The external ID. The value must be 1 to 15 bytes in length.', 'type' => 'string', 'maxLength' => 32, 'required' => false, 'example' => 'out123', 'title' => ''], ], [ - 'name' => 'MuteTime', + 'name' => 'SessionTimeout', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10000', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => '**SessionTimeout** '."\n" + .'The maximum call duration. The call is automatically ended when the specified duration is exceeded. Unit: seconds. Maximum value: 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '3600', 'minimum' => '300', 'example' => '120', 'title' => ''], ], [ - 'name' => 'ActionCodeBreak', + 'name' => 'TtsVoiceCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The voice code from the personalized voice interface. If this parameter is not specified, the value configured in the application is used.', 'type' => 'string', 'required' => false, 'example' => 'V745A7CED', 'title' => ''], ], [ - 'name' => 'DynamicId', + 'name' => 'TtsSpeed', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2234****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The voice speed. Valid values: 0 to 100. If this parameter is not specified, the value configured in the application is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '70', 'title' => ''], ], [ - 'name' => 'EarlyMediaAsr', + 'name' => 'TtsVolume', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'fasle', - 'required' => false, - 'type' => 'boolean', - ], + 'schema' => ['description' => 'The volume. Valid values: -200 to 200. If this parameter is not specified, the value configured in the application is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], ], - [ - 'name' => 'VoiceCodeParam', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'EE338D98-9BD3-4413-B165'], + 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CallId' => ['description' => 'The call record ID that identifies a call record.'."\n" + ."\n" + .'> When you call the LlmSmartCall operation to initiate an LLM-based outbound call, this call record ID (CallId) is returned.', 'type' => 'string', 'example' => '153955119976^140696759976', 'title' => ''], + ], 'example' => '', - 'required' => false, - 'type' => 'string', ], ], - [ - 'name' => 'SessionTimeout', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '120', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], - ], - [ - 'name' => 'ActionCodeTimeBreak', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '120', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ModelStatus.Invalid', 'errorMessage' => 'Model state invalid.', 'description' => 'Invalid model state.'], + ['errorCode' => 'MissingParameter.CallerNumber', 'errorMessage' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'description' => 'The request required parameter "CallerNumber" was not provided ".'], + ['errorCode' => 'InvalidParameter.ApplicationCode', 'errorMessage' => 'The specified parameter "ApplicationCode" is invalid.', 'description' => 'The parameter ApplicationCode is invalid.'], + ['errorCode' => 'ModelNotExist', 'errorMessage' => 'The model does not exist.', 'description' => 'The model does not exist.'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Full-duplex artificial intelligence Cloud call service call', + 'summary' => 'Initiates a full-duplex Artificial Intelligence Cloud Call Service call with support for personalized configurations.', + 'description' => '## Operation description'."\n" + .'- Before calling this operation, make sure that you have configured the ASR callback URL.'."\n" + .'- This operation is available only to users whose UIDs are added to the whitelist.'."\n" + .'- The request rate limit for a single user is 100 QPS.'."\n" + .'- `CalledNumber` and `CallerNumber` are required parameters that specify the called number and the calling number, respectively.'."\n" + .'- Optional parameters such as `StartWordParam`, `TtsVoiceCode`, `TtsSpeed`, and `TtsVolume` allow you to customize the call experience. If these parameters are not specified, the default settings of the application are used.'."\n" + .'- The `SessionTimeout` parameter specifies the maximum call duration in seconds. The call is automatically ended when the specified duration is exceeded. For the default value and valid range, refer to the relevant documentation.'."\n" + .'- The `OutId` field can be used to track a unique identifier in an external system. The value must be 1 to 32 bytes in length.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'TtsConf', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCallFullDuplex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CallId\\": \\"153955119976^140696759976\\"\\n}","type":"json"}]', + ], + 'MakeCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TtsStyle', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'xiaoyun', - 'required' => false, - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'TtsVolume', + 'name' => 'OuterAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'External account ID.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TtsSpeed', + 'name' => 'OuterAccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'External account type.', 'docRequired' => true, 'example' => 'ALIPAY', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'EnableITN', + 'name' => 'CommandCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - 'default' => 'false', - ], + 'schema' => ['description' => 'Operation code.', 'docRequired' => true, 'example' => 'outBound_Call', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'BackgroundFileCode', + 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Calling number.', 'docRequired' => true, 'example' => '0571456****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'BackgroundVolume', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '4', - 'minimum' => '-4', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Called number.', 'docRequired' => true, 'example' => '130****0000', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'BackgroundSpeed', + 'name' => 'ExtInfo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Pass-through business information.', 'example' => '{"bizId": 23323}', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '116012854210^10281427****', - 'type' => 'string', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + .'- **true** (Succeeded)'."\n" + .'- **false** (failed)', 'example' => 'true', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Initiate a Hotline Call', + 'summary' => 'Invoke MakeCall to initiate a call.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"OK\\",\\n \\"Code\\": \\"116012854210^10281427****\\"\\n}","errorExample":""},{"type":"xml","example":"<AiccsSmartCallResponse>\\n <Message>OK</Message>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <Data>OK</Data>\\n <Code>116012854210^10281427****</Code>\\n</AiccsSmartCallResponse>","errorExample":""}]', - ], - 'AiccsSmartCallOperate' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'MakeDoubleCall' => [ + 'summary' => 'You can invoke MakeDoubleCall to initiate a call by using the server-side software development kit (SDK).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'CallId', + 'name' => 'AccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '116012854210^102814279****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Account name.', 'example' => '12345', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Command', + 'name' => 'ServicerPhone', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'parallelBridge', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent\'s phone number. '."\n" + .'> This parameter is required only if the call needs to be placed through the agent\'s phone.', 'example' => '150****1234', 'required' => false, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Param', + 'name' => 'MemberPhone', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'Param', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'User\'s phone number.', 'example' => '1502123****', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'OutboundCallNumber', + 'in' => 'query', + 'schema' => ['description' => 'Outbound caller number.', 'example' => '0571000****', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'BizData', + 'in' => 'query', + 'schema' => ['description' => 'Business data carried in the request. The value must be in JSON format.', 'example' => '{"bizId": 123456}', 'required' => false, 'title' => '', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'Successful', 'title' => '', 'type' => 'string'], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', + 'description' => 'Returned data.', + 'properties' => [ + 'Acid' => ['description' => 'Session ID.', 'example' => '68255155365620598', 'title' => '', 'type' => 'string'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'Status code.', 'example' => '200', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"Successful\\",\\n \\"Data\\": {\\n \\"Acid\\": \\"68255155365620598\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Initiate a call by using the server-side SDK', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:00.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","errorExample":""},{"type":"xml","example":"<AiccsSmartCallOperateResponse>\\n <Message>OK</Message>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <Data>true</Data>\\n <Code>OK</Code>\\n</AiccsSmartCallOperateResponse>","errorExample":""}]', - 'title' => 'AiccsSmartCallOperate', - ], - 'BatchCreateQualityProjects' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeDoubleCall'], + ], ], + 'ramActions' => [], + ], + 'PageQueryAgentList' => [ + 'summary' => 'Returns a paginated list of agents.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'CheckFreqType', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['description' => 'The unique identifier for the agent.', 'type' => 'string', 'required' => false, 'example' => '1231*******', 'title' => ''], ], [ - 'name' => 'TimeRangeStart', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries to return per page. The default value is 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'TimeRangeEnd', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The page number. Pages start from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AnalysisIds', + 'name' => 'AgentName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'schema' => ['description' => 'The name of the agent.', 'type' => 'string', 'required' => false, 'example' => '测试智能体', 'title' => ''], ], [ - 'name' => 'InstanceList', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'maxItems' => 3, - ], - ], - [ - 'name' => 'ChannelTouchType', + 'name' => 'Status', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'description' => 'The status of the agent.', + 'enumValueTitles' => [1 => 'online', 'offline', 'under review', 'review failed', 'building', 'debugging', 'deployable', 'build failed'], + 'type' => 'integer', + 'format' => 'int64', 'required' => false, - 'maxItems' => 3, + 'example' => '7', + 'title' => '', ], ], ], @@ -21712,242 +14581,136 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'Access Denied', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', 'title' => ''], 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'Version' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ProjectId' => [ - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total count of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '14', 'title' => ''], + 'List' => [ + 'description' => 'A list of agents.', + 'type' => 'array', + 'items' => [ + 'description' => 'The agent object.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The agent status.', + 'enumValueTitles' => [1 => 'online', 'offline', 'under review', 'review failed', 'building', 'debugging', 'ready to go live', 'build failed'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + 'title' => '', + ], + 'LastOnlineTime' => ['description' => 'The time the agent was last online.', 'type' => 'string', 'example' => '2025-10-28 14:38:15', 'title' => ''], + 'ModifyTime' => ['description' => 'The time the agent was last modified.', 'type' => 'string', 'example' => '2025-10-28 17:10:17', 'title' => ''], + 'BusinessTypeName' => ['description' => 'The business scenario name.', 'type' => 'string', 'example' => '个人客户线索转化', 'title' => ''], + 'Description' => ['description' => 'The agent description.', 'type' => 'string', 'example' => '用于日常测试', 'title' => ''], + 'WithConfig' => ['description' => 'Indicates whether the agent has been configured.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The time the agent was created.', 'type' => 'string', 'example' => '2025-10-28 17:10:17', 'title' => ''], + 'AuditReason' => ['description' => 'The reason for the review failure.', 'type' => 'string', 'example' => '请补充流程说明', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '测试智能体', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '121312*******', 'title' => ''], + 'BuildFailReason' => ['description' => 'The reason for the build failure.', 'type' => 'string', 'example' => '系统错误', 'title' => ''], + 'ApplicationCode' => ['description' => 'The application code.', 'type' => 'string', 'example' => 'DFAS*****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', + 'title' => '', ], + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'example' => '', + 'title' => '', ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => 'The data returned by the request.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": 14,\\n \\"List\\": [\\n {\\n \\"Status\\": 7,\\n \\"LastOnlineTime\\": \\"2025-10-28 14:38:15\\",\\n \\"ModifyTime\\": \\"2025-10-28 17:10:17\\",\\n \\"BusinessTypeName\\": \\"个人客户线索转化\\",\\n \\"Description\\": \\"用于日常测试\\",\\n \\"WithConfig\\": false,\\n \\"CreateTime\\": \\"2025-10-28 17:10:17\\",\\n \\"AuditReason\\": \\"请补充流程说明\\",\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"121312*******\\",\\n \\"BuildFailReason\\": \\"系统错误\\",\\n \\"ApplicationCode\\": \\"DFAS*****\\"\\n }\\n ],\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query the list of communication agents', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:PageQueryAgentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, ], - 'ChangeChatAgentStatus' => [ - 'summary' => '修改在线客服状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'PageQueryAgentListNew' => [ + 'summary' => 'Retrieve a paginated list of agents (agency mode V2)', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'clientToken', - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '示例id', - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'account1', - 'required' => true, - 'title' => '账户名称', - 'type' => 'string', - ], + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => 'The agent name.', 'type' => 'string', 'required' => false, 'example' => '智能客服助手', 'title' => ''], ], [ - 'name' => 'Method', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'requestLogout', - 'required' => true, - 'title' => '修改到的状态类型', - 'type' => 'string', - 'enum' => [ - 'requestRest', - 'requestLogout', - 'restToWork', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'success', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'DF6A3FB7-A5AA-43BE-A65B', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'example' => '0', - 'title' => 'data', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', - ], - ], - 'title' => 'result', - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', - ], + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'format' => 'int64', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DF6A3FB7-A5AA-43BE-A65B\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ChangeChatAgentStatusResponse>\\n <Message>success</Message>\\n <RequestId>DF6A3FB7-A5AA-43BE-A65B</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>0</Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</ChangeChatAgentStatusResponse>","errorExample":""}]', - 'title' => 'ChangeChatAgentStatus', - ], - 'ChangeQualityProjectStatus' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => ['description' => 'The page index. This parameter is deprecated. Use `PageNo` instead.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'IsAvailable', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'Indicates whether the agent is available for outbound calls. The value is `true` if the agent\'s current deployment branch has a published version.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ @@ -21955,230 +14718,232 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The access denied detail.', 'type' => 'string', 'example' => 'Access denied due to insufficient permissions', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789012', 'title' => ''], + 'Message' => ['description' => 'The message that describes the status code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '41', 'title' => ''], + 'Total' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '28', 'title' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DeployBranchName' => ['description' => 'The effective branch name.', 'type' => 'string', 'example' => 'master', 'title' => ''], + 'ModifyTime' => ['description' => 'The last modified time.', 'type' => 'string', 'example' => '2024-01-15 10:30:00', 'title' => ''], + 'Description' => ['description' => 'The agent description.', 'type' => 'string', 'example' => '智能客服助手，提供自动化的客户服务支持', 'title' => ''], + 'AgentMode' => ['description' => 'The agent creation mode. Valid values:<br>'."\n" + .'`0`: Prompt mode (`PROMPT`). `1`: Conversation flow mode (`CONVERSATION`).<br>', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-20 12:00:00', 'title' => ''], + 'EffectiveVersionId' => ['description' => 'The effective version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '71', 'title' => ''], + 'Scene' => ['description' => 'The scene.', 'type' => 'string', 'example' => '个人线索转化', 'title' => ''], + 'ApplicationCode' => ['description' => 'The application code.', 'type' => 'string', 'example' => 'aicc_demo_app', 'title' => ''], + 'DeployBranchId' => ['description' => 'The deployment branch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '24', 'title' => ''], + 'LatestPublishTime' => ['description' => 'The most recent publish time.', 'type' => 'string', 'example' => '2024-01-20 12:00:00', 'title' => ''], + 'IsAvailable' => ['description' => 'Specifies whether the agent can be used for outbound calls. A value of `true` means the agent\'s current deployment branch has a published version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '51', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '智能客服助手', 'title' => ''], + 'EffectiveVersionName' => ['description' => 'The effective version name.', 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + ], + 'description' => 'The details of an agent.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The data list.', + 'title' => '', + ], + ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Specifies whether the request succeeded.'."\n" + ."\n" + .'- **`true`**: The request succeeded.'."\n" + ."\n" + .'- **`false`**: The request failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PageQueryAgentListNew', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:PageQueryAgentListNew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access denied due to insufficient permissions\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789012\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageSize\\": 41,\\n \\"Total\\": 6,\\n \\"PageNo\\": 28,\\n \\"List\\": [\\n {\\n \\"DeployBranchName\\": \\"master\\",\\n \\"ModifyTime\\": \\"2024-01-15 10:30:00\\",\\n \\"Description\\": \\"智能客服助手，提供自动化的客户服务支持\\",\\n \\"AgentMode\\": 0,\\n \\"CreateTime\\": \\"2024-01-20 12:00:00\\",\\n \\"EffectiveVersionId\\": 71,\\n \\"Scene\\": \\"个人线索转化\\",\\n \\"ApplicationCode\\": \\"aicc_demo_app\\",\\n \\"DeployBranchId\\": 24,\\n \\"LatestPublishTime\\": \\"2024-01-20 12:00:00\\",\\n \\"IsAvailable\\": true,\\n \\"AgentId\\": 51,\\n \\"AgentName\\": \\"智能客服助手\\",\\n \\"EffectiveVersionName\\": \\"v1.0.0\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'CreateOutboundTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryAiCallDetailPage' => [ + 'summary' => 'Queries the details of call tasks by paging.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '269272', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TaskType', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '1187**************', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'type' => 'string', + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 0: pending.'."\n" + ."\n" + .'- 1: completed.'."\n" + ."\n" + .'- 2: failed.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int64', 'required' => true, - 'docRequired' => true, + 'example' => '0', + 'title' => '', ], ], [ - 'name' => 'Description', + 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The batch ID. On the **Call Task Management** page, click Details to view the batch ID.', 'type' => 'string', 'required' => false, 'example' => '1183**************'."\n", 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The called number.', 'type' => 'string', 'required' => false, 'example' => '053714454****', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'EncryptionType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The encryption type. Valid values: 0: no encryption. 1: MD5. 2: SHA256. 3: SM3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'CallResult', 'in' => 'query', 'schema' => [ + 'description' => 'The call result. Valid values:'."\n" + .'- CALL_FORWARDING: call forwarding.'."\n" + .'- INCOMING_CALL_BARRED: incoming call barred.'."\n" + .'- CALL_REJECTED: call rejected.'."\n" + .'- ANSWERED: answered.'."\n" + .'- USER_BUSY: user busy.'."\n" + .'- POWERED_OFF: powered off.'."\n" + .'- NO_USER_RESPONSE: out of service area.'."\n" + .'- OPERATOR_BLOCK: blocked by carrier.'."\n" + .'- OTHERS: other status.'."\n" + .'- SUSPEND: suspended.'."\n" + .'- CANCEL: canceled by caller.'."\n" + .'- INVALID_NUMBER: invalid number.'."\n" + .'- UNAVAILABLE: temporarily unavailable.'."\n" + .'- NETWORK_BUSY: network busy.'."\n" + .'- NO_ANSWER: no answer.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'required' => false, + 'example' => 'ANSWERED', + 'title' => '', ], ], [ - 'name' => 'EndTime', + 'name' => 'MajorIntent', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The major intent. On the [Communication Agent Management](https://aiccs.console.aliyun.com/agent/customize) page, click the agent details to view the major intent.', 'type' => 'string', 'required' => false, 'example' => 'A', 'title' => ''], ], [ - 'name' => 'RetryTime', + 'name' => 'MinConversationDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '3', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The minimum call duration. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'RetryInterval', + 'name' => 'MaxConversationDuration', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2880', - 'minimum' => '0', - 'default' => '0', - ], + 'schema' => ['description' => 'The maximum call duration. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'SkillGroup', + 'name' => 'StartImportedTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The start import time. This value is a UNIX timestamp. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', 'title' => ''], ], [ - 'name' => 'Ani', + 'name' => 'EndImportedTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The end import time. This value is a UNIX timestamp. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'StartCallingTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The start calling time. This value is a UNIX timestamp. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', 'title' => ''], ], [ - 'name' => 'Model', + 'name' => 'EndCallingTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '10', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The end calling time. This value is a UNIX timestamp. Unit: ms.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748948749000', 'title' => ''], ], [ - 'name' => 'DepartmentId', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The ID reserved for the caller. This ID is returned to the caller in the receipt message.', 'type' => 'string', 'required' => false, 'example' => '94ba739b-c01a-ef91-335d-4be006c34899', 'title' => ''], ], [ - 'name' => 'ExtAttrs', + 'name' => 'DetailIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The list of task detail IDs. A maximum of 100 IDs can be specified.', + 'type' => 'array', + 'items' => ['description' => 'The detail ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '992913231****', 'title' => ''], 'required' => false, + 'example' => '', + 'title' => '', ], ], [ - 'name' => 'CallInfos', + 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The page number. The value must be greater than **0**. Default value: **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The number of entries per page. Default value: **10**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'default' => '10', 'title' => ''], ], ], 'responses' => [ @@ -22186,188 +14951,388 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5', 'title' => ''], 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'List' => [ + 'description' => 'The list of task detail data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The task detail data.', + 'type' => 'object', + 'properties' => [ + 'ImportedTime' => ['description' => 'The import time. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748948749000', 'title' => ''], + 'Status' => ['description' => 'The task detail status. Valid values:'."\n" + .'- 0: initialized.'."\n" + .'- 1: waiting to call.'."\n" + .'- 2: waiting to retry.'."\n" + .'- 3: calling.'."\n" + .'- 4: call ended.'."\n" + .'- 5: call failed.'."\n" + ."\n" + .'Only 4 and 5 are desired states.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], + 'Options' => ['description' => 'The variable information used at runtime. The information is stored in this field as key-value pairs.', 'type' => 'string', 'example' => '{'."\n" + .' "date": "666",'."\n" + .' "phoneNumber": "777",'."\n" + .' "distance": "555",'."\n" + .' "mendian": "444",'."\n" + .' "sex": "男",'."\n" + .' "name": "111",'."\n" + .' "age": "222"'."\n" + .'}', 'title' => ''], + 'EncryptionType' => ['description' => 'The encryption type. Valid values: 0: no encryption. 1: MD5. 2: SHA256. 3: SM3.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '0537101****', 'title' => ''], + 'CallResult' => ['description' => 'The call result.', 'type' => 'string', 'example' => '用户接通', 'title' => ''], + 'ConversationTurnCount' => ['description' => 'The number of conversation turns.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '1187**************', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'string', 'example' => '1183**************', 'title' => ''], + 'MajorIntent' => ['description' => 'The major intent.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'FailedReason' => ['description' => 'The reason for the call failure. This field is returned only when the call fails.', 'type' => 'string', 'example' => '账户停机', 'title' => ''], + 'BranchId' => ['description' => 'The branch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '49', 'title' => ''], + 'RecordingFilePath' => ['description' => 'The download path of the recording file. This field is returned only after the recording file is generated.', 'type' => 'string', 'example' => 'https://*******', 'title' => ''], + 'CallingTime' => ['description' => 'The calling time. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748948749000', 'title' => ''], + 'DetailId' => ['description' => 'The task detail ID.', 'type' => 'string', 'example' => '9662*************', 'title' => ''], + 'OutId' => ['description' => 'The external business serial number reserved for external input. You can use a unique ID for business association.', 'type' => 'string', 'example' => 'outId', 'title' => ''], + 'BranchVersionId' => ['description' => 'The version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'ConversationRecord' => ['description' => 'The chat record information. The structure is a JSON array, and the chat records are sorted in chronological order. The structure is as follows:'."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "content":"Chat content",'."\n" + .' "role":"Role",//Valid values: user and assistant (bot).'."\n" + .' }'."\n" + .']'."\n" + .'```', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "content": "111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>哎，你是谁？",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>你再说一遍。",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "哎，我没听清。",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "你在说什么？",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "您好，",'."\n" + .' "role": "assistant",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "我是**汽车总部销售服务顾问。",'."\n" + .' "role": "assistant",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？",'."\n" + .' "role": "assistant",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>哎，那我是谁？",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "你在说什么呢？",'."\n" + .' "role": "user",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "抱歉打扰了，111先生。",'."\n" + .' "role": "assistant",'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "祝您生活愉快！再见！",'."\n" + .' "role": "assistant",'."\n" + .' }'."\n" + .']', 'title' => ''], + 'ConversationDuration' => ['description' => 'The call duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'VersionNo' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'VersionName' => ['description' => 'The version name.', 'type' => 'string', 'example' => '默认版本', 'title' => ''], + 'BranchName' => ['description' => 'The branch name.', 'type' => 'string', 'example' => '默认分支', 'title' => ''], + 'CallId' => ['description' => 'The call ID.', 'type' => 'string', 'example' => '123*****456^123*****456', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"A57441B2-8EB6-5B93-9F37-0A51B8E2C9F5\\",\\n \\"Data\\": {\\n \\"PageSize\\": 5,\\n \\"Total\\": 2,\\n \\"PageNo\\": 60,\\n \\"List\\": [\\n {\\n \\"ImportedTime\\": 1748948749000,\\n \\"Status\\": 4,\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"EncryptionType\\": 1,\\n \\"CalledNumber\\": \\"0537101****\\",\\n \\"CallResult\\": \\"用户接通\\",\\n \\"ConversationTurnCount\\": 10,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"BatchId\\": \\"1183**************\\",\\n \\"MajorIntent\\": \\"A\\",\\n \\"FailedReason\\": \\"账户停机\\",\\n \\"BranchId\\": 49,\\n \\"RecordingFilePath\\": \\"https://*******\\",\\n \\"CallingTime\\": 1748948749000,\\n \\"DetailId\\": \\"9662*************\\",\\n \\"OutId\\": \\"outId\\",\\n \\"BranchVersionId\\": 9,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎，我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好，\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，那我是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了，111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快！再见！\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\",\\\\n }\\\\n]\\",\\n \\"ConversationDuration\\": 100,\\n \\"VersionNo\\": 1,\\n \\"VersionName\\": \\"默认版本\\",\\n \\"BranchName\\": \\"默认分支\\",\\n \\"CallId\\": \\"123*****456^123*****456\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Voice call task details', + 'description' => '- Before querying voice call task details, make sure that you have created a voice call task.'."\n" + ."\n" + .'- If you have not created a voice call task, create one on the **Call Task Management** page or by calling the [CreateAiCallTask](~~2926796~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAiCallDetailPage'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiCallDetailPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => null, ], - 'CreateQualityProject' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryAiCallTaskDetail' => [ + 'summary' => 'Gets basic information for a call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '1187**************', 'title' => ''], ], - [ - 'name' => 'CheckFreqType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The access denial details. This parameter is returned only if RAM validation fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only if the call fails.', 'type' => 'string', 'example' => '参数无效', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '23822ECB-8CAA-5C52-9C9E-807FD82A5A7F', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '1187**************'."\n", 'title' => ''], + 'ApplicationName' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'RetryEnable' => [ + 'description' => 'Indicates whether call retry is enabled. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', + ], + 'StartTime' => ['description' => 'The scheduled start time of the task. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', 'title' => ''], + 'RealStartTime' => ['description' => 'The actual start time of the task. This value is a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', 'title' => ''], + 'LinePhoneNum' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'ApplicationCode' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'CallerNumber' => ['description' => 'The caller ID.', 'type' => 'string', 'example' => '05370124****', 'title' => ''], + 'CallTimes' => [ + 'description' => 'The allowed call time windows.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a time window during which calls are allowed.', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end of the time window.', 'type' => 'string', 'example' => '09:00:00', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time window.', 'type' => 'string', 'example' => '12:00:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'RetryReasons' => [ + 'description' => 'The reasons for which a failed call can be retried.', + 'type' => 'array', + 'items' => [ + 'description' => 'The specific reason for the retry. Valid values:'."\n" + ."\n" + .'- `CALL_REJECTED`: The call was rejected.'."\n" + ."\n" + .'- `USER_BUSY`: The callee was busy.'."\n" + ."\n" + .'- `SUSPEND`: The service for the number was suspended.'."\n" + ."\n" + .'- `INVALID_NUMBER`: The number is invalid.'."\n" + ."\n" + .'- `POWERED_OFF`: The callee\'s phone was powered off.'."\n" + ."\n" + .'- `NETWORK_BUSY`: The network was busy.'."\n" + ."\n" + .'- `NO_ANSWER`: The call was not answered.', + 'enumValueTitles' => ['CALL_REJECTED' => '', 'USER_BUSY' => '', 'SUSPEND' => '', 'INVALID_NUMBER' => '', 'POWERED_OFF' => '', 'NETWORK_BUSY' => '', 'NO_ANSWER' => ''], + 'type' => 'string', + 'example' => 'CALL_REJECTED', + 'title' => '', + ], + 'example' => '', + 'title' => '', + ], + 'RetryCount' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PhoneType' => ['type' => 'integer', 'format' => 'int64', 'example' => '17', 'description' => '', 'title' => ''], + 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => '测试任务', 'title' => ''], + 'LineEncoding' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'StartType' => [ + 'description' => 'The start mode. Valid values:'."\n" + ."\n" + .'- `IMMEDIATE`: The task starts immediately.'."\n" + ."\n" + .'- `SCHEDULE`: The task starts at a scheduled time.', + 'enumValueTitles' => ['SCHEDULE' => '', 'IMMEDIATE' => ''], + 'type' => 'string', + 'example' => 'IMMEDIATE', + 'title' => '', + ], + 'AgentName' => ['description' => 'The name of the agent.', 'type' => 'string', 'example' => '测试智能体', 'title' => ''], + 'AgentId' => ['description' => 'The ID of the deployed agent.', 'type' => 'string', 'example' => '1180**************'."\n", 'title' => ''], + 'RetryInterval' => ['description' => 'The retry interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CallDays' => [ + 'description' => 'The days of the week on which calls are permitted.', + 'type' => 'array', + 'items' => [ + 'description' => 'A day of the week on which calls are permitted. Valid values:'."\n" + ."\n" + .'- `MONDAY`'."\n" + ."\n" + .'- `TUESDAY`'."\n" + ."\n" + .'- `WEDNESDAY`'."\n" + ."\n" + .'- `THURSDAY`'."\n" + ."\n" + .'- `FRIDAY`'."\n" + ."\n" + .'- `SATURDAY`'."\n" + ."\n" + .'- `SUNDAY`', + 'enumValueTitles' => ['WEDNESDAY' => '', 'MONDAY' => '', 'THURSDAY' => '', 'SUNDAY' => '', 'TUESDAY' => '', 'FRIDAY' => '', 'SATURDAY' => ''], + 'type' => 'string', + 'example' => 'MONDAY', + 'title' => '', + ], + 'example' => '', + 'title' => '', + ], + 'ConcurrentCount' => ['description' => 'The number of concurrent tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数无效\\",\\n \\"RequestId\\": \\"23822ECB-8CAA-5C52-9C9E-807FD82A5A7F\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1187**************\\\\n\\",\\n \\"ApplicationName\\": \\"示例值\\",\\n \\"RetryEnable\\": true,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"LinePhoneNum\\": \\"示例值\\",\\n \\"ApplicationCode\\": \\"示例值\\",\\n \\"CallerNumber\\": \\"05370124****\\",\\n \\"CallTimes\\": [\\n {\\n \\"EndTime\\": \\"09:00:00\\",\\n \\"StartTime\\": \\"12:00:00\\"\\n }\\n ],\\n \\"RetryReasons\\": [\\n \\"CALL_REJECTED\\"\\n ],\\n \\"RetryCount\\": 2,\\n \\"PhoneType\\": 17,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"LineEncoding\\": \\"示例值\\",\\n \\"StartType\\": \\"IMMEDIATE\\",\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"RetryInterval\\": 1,\\n \\"CallDays\\": [\\n \\"MONDAY\\"\\n ],\\n \\"ConcurrentCount\\": 10\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query Basic Information of an Intelligent Outbound Calling Job', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'QueryAiCallTaskPage' => [ + 'summary' => 'Retrieves a list of call tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ScopeType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'TimeRangeStart', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The value must be greater than **0**. The default value is **1**.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'TimeRangeEnd', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'default' => '10', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', + 'name' => 'Status', + 'in' => 'query', 'schema' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- **INIT**: The task is initialized but has not started.'."\n" + ."\n" + .'- **FAILED**: The task failed to start.'."\n" + ."\n" + .'- **RUNNING**: The task is running.'."\n" + ."\n" + .'- **STOPPED**: The task is stopped.', + 'enumValueTitles' => ['INIT' => '', 'FAILED' => '', 'RUNNING' => '', 'STOPPED' => ''], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'ChannelTouchType', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'required' => false, - 'maxItems' => 3, - ], - ], - [ - 'name' => 'DepList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], 'required' => false, - 'maxItems' => 3, + 'example' => 'INIT', + 'title' => '', ], ], [ - 'name' => 'GroupList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 3, - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name. The system performs a fuzzy search based on this name.', 'type' => 'string', 'required' => false, 'example' => '测试任务', 'title' => ''], ], [ - 'name' => 'ServicerList', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => false, - 'maxItems' => 3, - ], + 'name' => 'AgentName', + 'in' => 'query', + 'schema' => ['description' => 'The agent name. The system performs a fuzzy search based on this name.', 'type' => 'string', 'required' => false, 'example' => '测试智能体', 'title' => ''], ], [ - 'name' => 'AnalysisIds', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'required' => false, 'example' => '1187**************'."\n", 'title' => ''], ], ], 'responses' => [ @@ -22375,125 +15340,106 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The error message. This parameter is returned only if the call fails.', 'type' => 'string', 'example' => '参数不合法', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B99C5955-5664-573D-97BE-A7CC1AFD8401', 'title' => ''], 'Data' => [ + 'description' => 'The details of the tasks.', 'type' => 'object', 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'Version' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ProjectId' => [ - 'type' => 'integer', - 'format' => 'int64', + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '74', 'title' => ''], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'PageNo' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '37', 'title' => ''], + 'List' => [ + 'description' => 'The tasks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tasks.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the task.', + 'enumValueTitles' => ['Initializing', 'Running', 'Stopped', 'Start failed'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'TaskId' => [ + 'description' => 'The task ID.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => '1187**************', + 'title' => '', + ], + 'CompleteRate' => ['description' => 'The completion rate of the task.', 'type' => 'string', 'example' => '70%', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', 'title' => ''], + 'StartTime' => ['description' => 'The time when the task is scheduled to start. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', 'title' => ''], + 'RealStartTime' => ['description' => 'The time when the task actually starts. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1748932499000', 'title' => ''], + 'TotalCallCount' => ['description' => 'The total number of calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '58', 'title' => ''], + 'DayCallCount' => ['description' => 'The number of calls made on the current day.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '71', 'title' => ''], + 'TaskName' => ['description' => 'The task name.', 'type' => 'string', 'example' => '测试任务', 'title' => ''], + 'StartFailedReason' => ['description' => 'The reason why the task failed to start.', 'type' => 'string', 'example' => '智能体不在线', 'title' => ''], + 'FailedCount' => ['description' => 'The total number of failed tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '61', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '测试智能体', 'title' => ''], + 'CallingCount' => ['description' => 'The number of calls in progress.', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'string', 'example' => '1180**************'."\n", 'title' => ''], + 'SucceedCount' => ['description' => 'The total number of successful tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '36', 'title' => ''], + 'DayImportCount' => ['description' => 'The number of data entries imported on the current day.', 'type' => 'integer', 'format' => 'int64', 'example' => '400', 'title' => ''], + 'ConcurrentCount' => ['description' => 'The number of concurrent tasks.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'HistoryConnectRate' => ['description' => 'The historical connection rate. This is the historical number of connected calls divided by the total number of calls (`TotalCallCount`).', 'type' => 'string', 'example' => '95.89%', 'title' => ''], + 'DayConnectRate' => ['description' => 'The connection rate of the current day. This is the number of connected calls on the current day divided by the total number of calls on the current day (`DayCallCount`).', 'type' => 'string', 'example' => '74.14%', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified parameter is invalid.', - 'errorCode' => 'InvalidParameter', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"B99C5955-5664-573D-97BE-A7CC1AFD8401\\",\\n \\"Data\\": {\\n \\"PageSize\\": 74,\\n \\"Total\\": 72,\\n \\"PageNo\\": 37,\\n \\"List\\": [\\n {\\n \\"Status\\": 1,\\n \\"TaskId\\": \\"1187**************\\",\\n \\"CompleteRate\\": \\"70%\\",\\n \\"CreateTime\\": 1748932499000,\\n \\"StartTime\\": 1748932499000,\\n \\"RealStartTime\\": 1748932499000,\\n \\"TotalCallCount\\": 58,\\n \\"DayCallCount\\": 22,\\n \\"TotalCount\\": 71,\\n \\"TaskName\\": \\"测试任务\\",\\n \\"StartFailedReason\\": \\"智能体不在线\\",\\n \\"FailedCount\\": 61,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"CallingCount\\": 72,\\n \\"AgentId\\": \\"1180**************\\\\n\\",\\n \\"SucceedCount\\": 36,\\n \\"DayImportCount\\": 400,\\n \\"ConcurrentCount\\": 10,\\n \\"HistoryConnectRate\\": \\"95.89%\\",\\n \\"DayConnectRate\\": \\"74.14%\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query the list of outbound calling jobs for communication agents ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => null, + 'ramActions' => [], ], - 'CreateQualityRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryAiVoiceAgentDetail' => [ + 'summary' => 'Retrieve the details of a communication agent.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'RuleTag', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'MatchType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], - ], - [ - 'name' => 'KeyWords', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => 'The agent ID.', 'type' => 'string', 'required' => false, 'example' => '123123********', 'title' => ''], ], ], 'responses' => [ @@ -22501,269 +15447,748 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'AccessDeniedDetail' => ['description' => 'The detailed reason why the access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C60BEB2DF09A', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the agent.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The status of the agent.', + 'enumValueTitles' => [1 => 'Online', 'Offline', 'In Review', 'Review Failed', 'Building', 'Debugging', 'Ready to Release', 'Build Failed'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '7', + 'title' => '', + ], + 'BusinessTypeName' => ['description' => 'The name of the business scenario.', 'type' => 'string', 'example' => '个人线索转化', 'title' => ''], + 'Description' => ['description' => 'The description of the agent.', 'type' => 'string', 'example' => '日常测试使用。', 'title' => ''], + 'AiVoiceAgentModelConfig' => [ + 'description' => 'The model configuration for the agent.', + 'type' => 'object', + 'properties' => [ + 'BasicTaskDescription' => ['description' => 'The configuration for the basic task.', 'type' => 'string', 'example' => '任务描述。', 'title' => ''], + 'MainPurpose' => [ + 'description' => 'The main intent configuration.', + 'type' => 'object', + 'properties' => [ + 'MainPurposeEnum' => [ + 'description' => 'The list of valid values for the main intent.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the value.', 'type' => 'string', 'example' => '意向强烈。', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the value.', 'type' => 'string', 'example' => 'd5606d80-7625-dcea-xxxx-17f66fbb564a', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'MainPurposeName' => ['description' => 'The name of the main intent.', 'type' => 'string', 'example' => '通话效果评级', 'title' => ''], + 'MainPurposeType' => ['description' => 'The value type of the main intent. Currently, only the `ENUM` type is supported.', 'type' => 'string', 'example' => 'ENUM', 'title' => ''], + 'MainPurposeDescription' => ['description' => 'The description of the main intent.', 'type' => 'string', 'example' => '通话效果评级：A、B、C、D，（A最好）', 'title' => ''], + 'Id' => ['description' => 'The ID of the main intent.', 'type' => 'string', 'example' => '1ee6e994-08e0-xxxx-f662-1659cc54d409', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'ChildTaskList' => [ + 'description' => 'The list of subtask configurations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ChildTaskName' => ['description' => 'The name of the subtask.', 'type' => 'string', 'example' => '开场与邀约', 'title' => ''], + 'ChildTaskDescription' => ['description' => 'The description of the subtask.', 'type' => 'string', 'example' => '新用户邀约: \\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the subtask.', 'type' => 'string', 'example' => '280cd4bf-*******df472c', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomExceptionFileName' => ['description' => 'The name of the custom exception file.', 'type' => 'string', 'example' => '异常测试文件.xlsx', 'title' => ''], + 'StartWordType' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''], + 'BusinessType' => [ + 'description' => 'The business scenario.', + 'enumValueTitles' => [1 => 'Personal lead conversion', 'Enterprise lead conversion', 'Membership renewal or repurchase reminders', 'Membership promotion or coupon reminders', 'Simple Q\\&A customer service', 'Other'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + 'title' => '', + ], + 'CustomExceptionUrlPath' => ['description' => 'This parameter is deprecated and will be removed in a future release.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'KnowledgeId' => ['description' => 'The ID of the knowledge base.', 'type' => 'string', 'example' => '1232131*******', 'title' => ''], + 'KnowledgeDocOriginalNameList' => [ + 'description' => 'A list of original file names for the knowledge base documents.', + 'type' => 'array', + 'items' => ['description' => 'The file name.', 'type' => 'string', 'example' => '**会话引擎测试.xlsx', 'title' => ''], + 'example' => '', + 'title' => '', + ], + 'KnowledgeEnable' => ['description' => 'Specifies whether the agent is associated with a knowledge base.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CustomExceptionEnable' => ['description' => 'Specifies whether custom exception handling is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Prologue' => ['description' => 'The opening statement.', 'type' => 'string', 'example' => '你好，这里是******。', 'title' => ''], + 'CustomExceptionFileId' => ['description' => 'The ID of the custom exception file.', 'type' => 'string', 'example' => 'OSS文件ID', 'title' => ''], + 'PhoneTagConfig' => [ + 'description' => 'The call variable configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneTagType' => [ + 'description' => 'The data type of the variable.', + 'enumValueTitles' => ['ENUM' => 'Enumerated type', 'TEXT' => 'Text type'], + 'type' => 'string', + 'example' => 'ENUM', + 'title' => '', + ], + 'PhoneTagName' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => '意向车系', 'title' => ''], + 'PhoneTagRequired' => ['description' => 'Specifies whether the variable is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the variable.', 'type' => 'string', 'example' => '280cd4bf-*******df472c'."\n", 'title' => ''], + 'PhoneTagSource' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'PhoneTagDescription' => ['description' => 'The description of the variable.', 'type' => 'string', 'example' => '用户感兴趣的车系。', 'title' => ''], + 'PhoneTagEnum' => [ + 'description' => 'A list of enumerated values for the variable. This parameter is returned only if the value of `PhoneTagType` is `ENUM`.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the enumerated value.', 'type' => 'string', 'example' => '客户完全不接受挽留', 'title' => ''], + 'Value' => ['description' => 'The enumerated value.', 'type' => 'string', 'example' => '完全不接受', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the enumerated value.', 'type' => 'string', 'example' => 'c3d4ff4e-*********bc26dc044682', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'PhoneTagKey' => ['description' => 'The key of the variable.', 'type' => 'string', 'example' => 'testParam', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'FlowDesc' => ['description' => 'The description of the advanced task flow.', 'type' => 'string', 'example' => '这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍', 'title' => ''], + 'UserRole' => ['description' => 'The user role.', 'type' => 'string', 'example' => '急需课程的新用户', 'title' => ''], + 'TaskType' => [ + 'description' => 'The task type.', + 'enumValueTitles' => ['BASIC' => 'Basic task', 'ADVANCED' => 'Advanced task'], + 'type' => 'string', + 'example' => 'ADVANCED', + 'title' => '', + ], + 'SysRole' => ['description' => 'The system role.', 'type' => 'string', 'example' => '课程销售', 'title' => ''], + 'OutputTagConfig' => [ + 'description' => 'The output tag configuration.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OutputTagDescription' => ['description' => 'The description of the tag.', 'type' => 'string', 'example' => '记录本次通话的最终状态', 'title' => ''], + 'OutputTagType' => [ + 'description' => 'The data type of the tag.', + 'enumValueTitles' => ['ENUM' => 'Enumerated type', 'TEXT' => 'Text type'], + 'type' => 'string', + 'example' => 'ENUM', + 'title' => '', + ], + 'OutputTagEnum' => [ + 'description' => 'The enumerated values for the tag. This parameter is returned only if the value of `OutputTagType` is `ENUM`.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the enumerated value.', 'type' => 'string', 'example' => '高（非常积极，大概率转化）', 'title' => ''], + 'Value' => ['description' => 'The enumerated value.', 'type' => 'string', 'example' => '高', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the enumerated value.', 'type' => 'string', 'example' => '8757************2c499fa', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'OutputTagName' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => '客户意向度', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the tag.', 'type' => 'string', 'example' => '8757************2c499fa'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'CustomExceptionVoiceStyle' => [ + 'description' => 'The voice style.', + 'enumValueTitles' => [1 => 'Plain', 'Friendly', 'Professional', 'Formal'], + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + 'title' => '', + ], + 'RecordingFile' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'CustomExceptionList' => [ + 'description' => 'This parameter is deprecated and will be removed in a future release.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ExceptionType' => ['description' => 'The exception type.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'SupportBreak' => ['description' => 'Specifies whether interruption is supported.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Reply' => ['description' => 'The reply.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'ExceptionSign' => ['description' => 'Specifies whether to output the content as an exception tag.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'KnowledgeDocNameList' => [ + 'description' => 'The list of knowledge document names.', + 'type' => 'array', + 'items' => ['description' => 'The file name.', 'type' => 'string', 'example' => '117d2********388f2a615be5c0d3546e.xlsx', 'title' => ''], + 'example' => '', + 'title' => '', + ], + 'KnowledgeDocIdList' => [ + 'description' => 'The list of knowledge document IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the knowledge document.', 'type' => 'string', 'example' => '12213******', 'title' => ''], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', + ], + 'KnowledgeName' => ['description' => 'The name of the knowledge base.', 'type' => 'string', 'example' => '测试知识库', 'title' => ''], + 'VoiceStyleName' => ['description' => 'The name of the voice style.', 'type' => 'string', 'example' => '亲切', 'title' => ''], + 'AgentId' => ['description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '12311212******', 'title' => ''], + 'AgentName' => ['description' => 'The name of the agent.', 'type' => 'string', 'example' => '测试智能体', 'title' => ''], + 'AiVoiceAgentCallConfig' => [ + 'description' => 'The voice configuration for AI-powered outbound calls.', + 'type' => 'object', + 'properties' => [ + 'VocabId' => ['description' => 'The ID of the hotword.', 'type' => 'string', 'example' => 'afb2c43**********83e6df30551c11f7', 'title' => ''], + 'TtsConfig' => [ + 'description' => 'The TTS configuration.', + 'type' => 'object', + 'properties' => [ + 'VoiceCode' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'MixingTemplate' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''], + 'BackgroundEnabled' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], + 'TtsVolume' => ['description' => 'The TTS playback volume.'."\n" + ."\n" + .'> - Valid values: 0 to 100. Default value: 0.'."\n" + .'>'."\n" + .'> - If this parameter is not specified, the volume configured for the large model application is used.', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'example' => 'longxiaoxia_v2p1', 'title' => ''], + 'VoiceType' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'MixingEnabled' => ['type' => 'boolean', 'example' => 'true', 'description' => '', 'title' => ''], + 'TtsSpeed' => ['description' => 'The TTS speech rate.'."\n" + ."\n" + .'> - Valid values: -200 to 200. Default value: 0.'."\n" + .'>'."\n" + .'> - If this parameter is not specified, the speech rate configured for the large model application is used.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], + 'BackgroundSound' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''], + 'BackgroundVolume' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + 'EventConfig' => [ + 'description' => 'The call event configuration.', + 'type' => 'object', + 'properties' => [ + 'MuteActive' => ['description' => 'Specifies whether to trigger the model on the first silence event.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'SessionTimeout' => ['description' => 'The maximum call duration, in seconds. The call automatically disconnects when this duration is exceeded.'."\n" + ."\n" + .'> - Maximum value: 3600.'."\n" + .'>'."\n" + .'> - Minimum value: 600.', 'type' => 'integer', 'format' => 'int64', 'example' => '600', 'title' => ''], + 'CallAssistantHangup' => ['description' => 'Specifies whether to hang up the call if an answering machine is detected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CallAssistantRecognize' => ['description' => 'Whether answering machine detection is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MuteDuration' => ['description' => 'Silence duration.'."\n" + ."\n" + .'> - Maximum value: 15 s.'."\n" + .'>'."\n" + .'> - Minimum value: 3 s.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'MuteHangupNum' => ['description' => 'The system automatically disconnects the call after a specified number of consecutive silence events.'."\n" + ."\n" + .'> - Maximum value: 5.'."\n" + .'>'."\n" + .'> - Minimum value: 1.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful. Possible values:'."\n" + ."\n" + .'- **true**: The operation was successful.'."\n" + ."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified parameter is invalid.', - 'errorCode' => 'InvalidParameter', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C60BEB2DF09A\\",\\n \\"Data\\": {\\n \\"Status\\": 7,\\n \\"BusinessTypeName\\": \\"个人线索转化\\",\\n \\"Description\\": \\"日常测试使用。\\",\\n \\"AiVoiceAgentModelConfig\\": {\\n \\"BasicTaskDescription\\": \\"任务描述。\\",\\n \\"MainPurpose\\": {\\n \\"MainPurposeEnum\\": [\\n {\\n \\"Description\\": \\"意向强烈。\\",\\n \\"Value\\": \\"A\\",\\n \\"Id\\": \\"d5606d80-7625-dcea-xxxx-17f66fbb564a\\"\\n }\\n ],\\n \\"MainPurposeName\\": \\"通话效果评级\\",\\n \\"MainPurposeType\\": \\"ENUM\\",\\n \\"MainPurposeDescription\\": \\"通话效果评级：A、B、C、D，（A最好）\\",\\n \\"Id\\": \\"1ee6e994-08e0-xxxx-f662-1659cc54d409\\"\\n },\\n \\"ChildTaskList\\": [\\n {\\n \\"ChildTaskName\\": \\"开场与邀约\\",\\n \\"ChildTaskDescription\\": \\"新用户邀约: \\\\\\\\\\\\\\"喂，家长您好！我是*****的王老师，我们现在有**课程100个试听名额，想帮宝贝安排一下体验，您看什么时候比较方便呢？\\\\\\\\\\",\\n \\"Id\\": \\"280cd4bf-*******df472c\\"\\n }\\n ],\\n \\"CustomExceptionFileName\\": \\"异常测试文件.xlsx\\",\\n \\"StartWordType\\": 1,\\n \\"BusinessType\\": 1,\\n \\"CustomExceptionUrlPath\\": \\"-\\",\\n \\"KnowledgeId\\": \\"1232131*******\\",\\n \\"KnowledgeDocOriginalNameList\\": [\\n \\"**会话引擎测试.xlsx\\"\\n ],\\n \\"KnowledgeEnable\\": false,\\n \\"CustomExceptionEnable\\": false,\\n \\"Prologue\\": \\"你好，这里是******。\\",\\n \\"CustomExceptionFileId\\": \\"OSS文件ID\\",\\n \\"PhoneTagConfig\\": [\\n {\\n \\"PhoneTagType\\": \\"ENUM\\",\\n \\"PhoneTagName\\": \\"意向车系\\",\\n \\"PhoneTagRequired\\": true,\\n \\"Id\\": \\"280cd4bf-*******df472c\\\\n\\",\\n \\"PhoneTagSource\\": \\"示例值\\",\\n \\"PhoneTagDescription\\": \\"用户感兴趣的车系。\\",\\n \\"PhoneTagEnum\\": [\\n {\\n \\"Description\\": \\"客户完全不接受挽留\\",\\n \\"Value\\": \\"完全不接受\\",\\n \\"Id\\": \\"c3d4ff4e-*********bc26dc044682\\"\\n }\\n ],\\n \\"PhoneTagKey\\": \\"testParam\\"\\n }\\n ],\\n \\"FlowDesc\\": \\"这次外呼通过三个核心步骤与家长沟通，........ 3. 用户需求 > 主动介绍\\",\\n \\"UserRole\\": \\"急需课程的新用户\\",\\n \\"TaskType\\": \\"ADVANCED\\",\\n \\"SysRole\\": \\"课程销售\\",\\n \\"OutputTagConfig\\": [\\n {\\n \\"OutputTagDescription\\": \\"记录本次通话的最终状态\\",\\n \\"OutputTagType\\": \\"ENUM\\",\\n \\"OutputTagEnum\\": [\\n {\\n \\"Description\\": \\"高（非常积极，大概率转化）\\",\\n \\"Value\\": \\"高\\",\\n \\"Id\\": \\"8757************2c499fa\\"\\n }\\n ],\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"Id\\": \\"8757************2c499fa\\\\n\\"\\n }\\n ],\\n \\"CustomExceptionVoiceStyle\\": 2,\\n \\"RecordingFile\\": \\"示例值\\",\\n \\"CustomExceptionList\\": [\\n {\\n \\"ExceptionType\\": \\"-\\",\\n \\"SupportBreak\\": false,\\n \\"Reply\\": \\"-\\",\\n \\"ExceptionSign\\": true\\n }\\n ],\\n \\"KnowledgeDocNameList\\": [\\n \\"117d2********388f2a615be5c0d3546e.xlsx\\"\\n ],\\n \\"KnowledgeDocIdList\\": [\\n \\"12213******\\"\\n ]\\n },\\n \\"KnowledgeName\\": \\"测试知识库\\",\\n \\"VoiceStyleName\\": \\"亲切\\",\\n \\"AgentId\\": 0,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"AiVoiceAgentCallConfig\\": {\\n \\"VocabId\\": \\"afb2c43**********83e6df30551c11f7\\",\\n \\"TtsConfig\\": {\\n \\"VoiceCode\\": \\"示例值\\",\\n \\"MixingTemplate\\": 1,\\n \\"BackgroundEnabled\\": true,\\n \\"TtsVolume\\": 72,\\n \\"TtsStyle\\": \\"longxiaoxia_v2p1\\",\\n \\"VoiceType\\": \\"示例值\\",\\n \\"MixingEnabled\\": true,\\n \\"TtsSpeed\\": 34,\\n \\"BackgroundSound\\": 1,\\n \\"BackgroundVolume\\": 1\\n },\\n \\"EventConfig\\": {\\n \\"MuteActive\\": false,\\n \\"SessionTimeout\\": 600,\\n \\"CallAssistantHangup\\": false,\\n \\"CallAssistantRecognize\\": true,\\n \\"MuteDuration\\": 10,\\n \\"MuteHangupNum\\": 1\\n }\\n }\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Query details of a communication agent', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiVoiceAgentDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, ], - 'CreateThirdSsoAgent' => [ - 'summary' => '创建坐席并开通sso登录能力', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryAiVoiceAgentDetailNew' => [ + 'summary' => 'Gets details for a specified agent, including its basic, branch, and version information.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsTY5M4L'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'clientToken', - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => 'param1', - 'type' => 'string', - ], - ], - [ - 'name' => 'ClientId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => true, - 'title' => 'param2', - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'accountId1', - 'required' => true, - 'title' => 'param3', - 'type' => 'string', - ], - ], - [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'accountName1', - 'required' => true, - 'title' => 'param4', - 'type' => 'string', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'title' => 'param5', - 'type' => 'string', - ], + 'name' => 'BranchId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the branch. If you do not specify this parameter, the active branch is used.', 'type' => 'string', 'required' => false, 'example' => '12', 'title' => ''], ], [ - 'name' => 'SkillGroupIds', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => 'param6', - 'type' => 'array', - ], + 'name' => 'AgentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the agent.', 'type' => 'string', 'required' => true, 'example' => '1234***5678', 'title' => ''], ], [ - 'name' => 'RoleIds', - 'in' => 'formData', - 'style' => 'flat', - 'schema' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'type' => 'integer', - ], - 'required' => false, - 'title' => 'param7', - 'type' => 'array', - ], + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the version. If you do not specify this parameter, the system uses the latest published version for the specified branch. You must specify BranchId when you use this parameter.', 'type' => 'string', 'required' => false, 'example' => '21', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'Success', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => 'requestId', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], + 'AccessDeniedDetail' => ['description' => 'The reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '742C9243-2870-B8D6-0C68-C12345AABBCC0', 'title' => ''], + 'Message' => ['description' => 'The message that is associated with the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'title' => '新创建的坐席id', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', + 'type' => 'object', + 'properties' => [ + 'AgentCallConfig' => [ + 'type' => 'object', + 'properties' => [ + 'StartWordType' => ['description' => 'The type of the prologue. Valid values: `0` (text) and `1` (recording).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Prologue' => ['description' => 'The prologue.', 'type' => 'string', 'example' => '你好，这里是******。', 'title' => ''], + 'VocabId' => ['description' => 'The ID of the hotword vocabulary.', 'type' => 'string', 'example' => 'afb2c43**********83e6df30551c11f7', 'title' => ''], + 'TtsConfig' => [ + 'type' => 'object', + 'properties' => [ + 'VoiceCode' => ['description' => 'The voice code.', 'type' => 'string', 'example' => 'V123ABC00', 'title' => ''], + 'MixingTemplate' => ['description' => 'The ID of the audio mixing template.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BackgroundEnabled' => ['description' => 'Specifies whether to enable background sound.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TtsVolume' => ['description' => 'The volume of TTS playback. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '88', 'title' => ''], + 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'example' => 'longxiaoxia_v2p1', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID. This parameter is required only for third-party voices.', 'type' => 'string', 'example' => 'voice-12345', 'title' => ''], + 'CustomerAccountId' => ['description' => 'The account of the third-party voice platform.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], + 'VoiceType' => ['description' => 'The type of the TTS voice. Valid values:'."\n" + ."\n" + .'`VOICE_TYPE_SYSTEM`: a system voice.'."\n" + ."\n" + .'`VOICE_TYPE_CLONE`: a cloned voice.'."\n" + ."\n" + .'`VOICE_TYPE_DOUBAO`: a Doubao voice.'."\n" + ."\n" + .'`VOICE_TYPE_MINIMAX`: a Minimax voice.'."\n" + ."\n" + .'`VOICE_TYPE_OPENTTS`: an open voice.'."\n" + ."\n" + .'`VOICE_TYPE_BL_CUSTOM`: a high-quality custom cloned voice.', 'type' => 'boolean', 'example' => 'VOICE_TYPE_SYSTEM', 'title' => ''], + 'MixingEnabled' => ['description' => 'Specifies whether to enable audio mixing.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TtsSpeed' => ['description' => 'The speech rate for TTS playback. Valid values: -200 to 200. Default value: 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'BackgroundSound' => ['description' => 'The ID of the background sound.', 'type' => 'integer', 'format' => 'int64', 'example' => '17', 'title' => ''], + 'BackgroundVolume' => ['description' => 'The volume of the background sound. Valid values: `0` (low), `1` (medium), and `2` (high).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'description' => 'The Text-to-Speech (TTS) configuration.', + 'title' => '', + ], + 'EventConfig' => [ + 'type' => 'object', + 'properties' => [ + 'MuteActive' => ['description' => 'Specifies whether to wake up the model upon the first mute event.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SessionTimeout' => ['description' => 'The maximum call duration. Unit: seconds. Valid values: 600 to 3600. The call is automatically disconnected if this duration is exceeded.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'CallAssistantHangup' => ['description' => 'Specifies whether to disconnect the call when an answering machine is detected.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CallAssistantRecognize' => ['description' => 'Specifies whether to enable answering machine detection.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MuteDuration' => ['description' => 'The mute duration. Unit: seconds. Valid values: 3 to 15.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'MuteHangupNum' => ['description' => 'The number of consecutive mute events that trigger an automatic disconnection. Valid values: 1 to 5.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'example' => '', + 'description' => 'The event configuration.', + 'title' => '', + ], + 'RecordingFile' => ['description' => 'The URL of the audio file for the prologue. This parameter is returned only when `StartWordType` is set to `1`.', 'type' => 'string', 'example' => '/oss-file-key', 'title' => ''], + 'TransferConfig' => [ + 'type' => 'object', + 'properties' => [ + 'SeatRouteName' => ['description' => 'The name of the agent route.', 'type' => 'string', 'example' => '人工座席', 'title' => ''], + 'CalledNumber' => ['description' => 'The called number.', 'type' => 'string', 'example' => '123111122222', 'title' => ''], + 'CustomerRouteCode' => ['description' => 'The customer route code.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'CallingNumberType' => ['description' => 'The type of the called number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Enabled' => ['description' => 'Specifies whether to enable call transfer.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CallerNumberType' => ['description' => 'The type of the caller number.', 'type' => 'integer', 'format' => 'int64', 'example' => '48', 'title' => ''], + 'ExtraInfo' => ['description' => 'The supplementary information.', 'type' => 'string', 'example' => 'Additional information for the agent', 'title' => ''], + 'TransferType' => ['description' => 'The agent transfer type.', 'type' => 'integer', 'format' => 'int64', 'example' => '73', 'title' => ''], + 'CallingNumber' => ['description' => 'The destination number for the transfer, such as the phone number of a customer service agent.', 'type' => 'string', 'example' => '123111122222', 'title' => ''], + 'CallerNumber' => ['description' => 'The caller number.', 'type' => 'string', 'example' => '123111122222', 'title' => ''], + 'TransferBizId' => ['description' => 'The business ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'SeatRouteCode' => ['description' => 'The agent route code.', 'type' => 'string', 'example' => 'SEAT_CTI_A_NET', 'title' => ''], + 'TransferContent' => ['description' => 'The prompt that is played when the call is transferred to a manual agent.', 'type' => 'string', 'example' => '提示语', 'title' => ''], + 'FailureContent' => ['description' => 'The prompt that is played when the transfer to a manual agent fails.', 'type' => 'string', 'example' => '失败说明', 'title' => ''], + ], + 'example' => '', + 'description' => 'The configuration for transferring the call to a manual agent.', + 'title' => '', + ], + ], + 'example' => '', + 'description' => 'The voice configuration for intelligent outbound calls.', + 'title' => '', + ], + 'AgentMode' => ['description' => 'The build mode. Valid values:'."\n" + ."\n" + .'- `0`: prompt-based mode.'."\n" + ."\n" + .'- `1`: dialog flow mode.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BranchDesc' => ['description' => 'The branch description.', 'type' => 'string', 'example' => '默认分支', 'title' => ''], + 'BranchDeployStatus' => ['description' => 'The deployment status. Valid values:'."\n" + ."\n" + .'- `0`: Inactive (NOT\\_EFFECT).'."\n" + ."\n" + .'- `1`: Active (EFFECT).', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BranchId' => ['description' => 'The branch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], + 'BranchName' => ['description' => 'The branch name.', 'type' => 'string', 'example' => '默认版本', 'title' => ''], + 'Scene' => ['description' => 'The scenario.', 'type' => 'string', 'example' => '个人客户线索转化', 'title' => ''], + 'AgentDemandConfig' => [ + 'type' => 'object', + 'properties' => [ + 'BasicTaskDescription' => ['description' => 'The basic task configuration.', 'type' => 'string', 'example' => '进行产品营销，介绍优势特点', 'title' => ''], + 'CoreTarget' => ['description' => 'The core objective.', 'type' => 'string', 'example' => '销售线索转化', 'title' => ''], + 'AiGenerate' => ['description' => 'Specifies whether the agent was built with AI assistance.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'UserRole' => ['description' => 'The user role.', 'type' => 'string', 'example' => '潜在客户', 'title' => ''], + 'BusinessType' => ['description' => 'The business scenario.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SysRole' => ['description' => 'The system role.', 'type' => 'string', 'example' => '销售', 'title' => ''], + ], + 'example' => '', + 'description' => 'The business requirement configuration for the agent.', + 'title' => '', + ], + 'SummaryConfig' => [ + 'type' => 'object', + 'properties' => [ + 'MainPurpose' => [ + 'type' => 'object', + 'properties' => [ + 'MainPurposeEnum' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the value.', 'type' => 'string', 'example' => 'Description of the tag value', 'title' => ''], + 'Value' => ['description' => 'The value.', 'type' => 'string', 'example' => 'Tag value example', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the tag.', 'type' => 'string', 'example' => 'tag_12345', 'title' => ''], + ], + 'description' => 'The enumerated values for the main intent.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The enumerated values for the main intent.', + 'title' => '', + ], + 'MainPurposeName' => ['description' => 'The name of the main intent.', 'type' => 'string', 'example' => 'Customer inquiry handling', 'title' => ''], + 'MainPurposeType' => ['description' => 'The value type of the main intent. Valid values: `TEXT` and `ENUM`.', 'type' => 'string', 'example' => 'ENUM', 'title' => ''], + 'MainPurposeDescription' => ['description' => 'The description of the main intent.', 'type' => 'string', 'example' => 'Description of the main intent', 'title' => ''], + 'Id' => ['description' => 'The ID of the main intent.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'example' => '', + 'description' => 'The main intent.', + 'title' => '', + ], + 'CallResultTagConfig' => [ + 'type' => 'object', + 'properties' => [ + 'MappingTag' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'The mapping of call results to tags.', 'type' => 'string', 'example' => '"CANCEL": "{\\"tag\\":\\"test\\",\\"desc\\":\\"11\\"}"', 'title' => ''], + 'description' => 'The mapping of call results to tags.', + 'title' => '', + 'example' => '', + ], + 'DefaultTag' => [ + 'type' => 'object', + 'properties' => [ + 'Desc' => ['description' => 'The description.', 'type' => 'string', 'example' => '标签说明', 'title' => ''], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'example' => '标签1', 'title' => ''], + ], + 'example' => '', + 'description' => 'The default fallback tag information.', + 'title' => '', + ], + ], + 'example' => '', + 'description' => 'The configuration for mapping call results to tags.', + 'title' => '', + ], + 'OutputTagConfig' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OutputTagDescription' => ['description' => 'The description of the output tag.', 'type' => 'string', 'example' => '用户购买产品的意愿', 'title' => ''], + 'OutputTagType' => ['description' => 'The value type of the output tag. Valid values: `TEXT` and `ENUM`.', 'type' => 'string', 'example' => 'ENUM', 'title' => ''], + 'OutputTagEnum' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The tag description.', 'type' => 'string', 'example' => '用户有较高购买意愿', 'title' => ''], + 'Value' => ['description' => 'The enumerated value of the tag.', 'type' => 'string', 'example' => '高意愿', 'title' => ''], + 'Id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'description' => 'The enumerated values of the tag. This parameter is returned only when the tag value type is `ENUM`.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The enumerated values for the output tag.', + 'title' => '', + ], + 'OutputTagName' => ['description' => 'The name of the output tag.', 'type' => 'string', 'example' => '购买意愿', 'title' => ''], + 'Id' => ['description' => 'The ID of the output tag.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => 'The output tag configuration.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The output tag configuration.', + 'title' => '', + ], + ], + 'example' => '', + 'description' => 'The call summary configuration.', + 'title' => '', + ], + 'PhoneTagConfig' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'PhoneTagType' => ['description' => 'The type of the call variable. Valid values: `TEXT` and `ENUM`.', 'type' => 'string', 'example' => 'ENUM', 'title' => ''], + 'PhoneTagName' => ['description' => 'The description of the call variable.', 'type' => 'string', 'example' => '用户性别', 'title' => ''], + 'PhoneTagRequired' => ['description' => 'Specifies whether the call variable is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Id' => ['description' => 'The ID of the call variable.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'PhoneTagSource' => ['description' => 'The source of the call variable.', 'type' => 'string', 'example' => 'MANUAL_CREATE', 'title' => ''], + 'PhoneTagKey' => ['description' => 'The key of the call variable.', 'type' => 'string', 'example' => 'gender', 'title' => ''], + 'PhoneTagEnum' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'gender', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'male', 'title' => ''], + 'Id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'description' => 'The enumerated values for the call variable.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The enumerated values for the call variable.', + 'title' => '', + ], + ], + 'description' => 'The call variable configuration.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The call variable configuration.', + 'title' => '', + ], + 'AgentDesc' => ['description' => 'The agent description.', 'type' => 'string', 'example' => '日常测试使用。', 'title' => ''], + 'AgentId' => ['description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3021893791', 'title' => ''], + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => '测试智能体', 'title' => ''], + 'KnowledgeConfig' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeIds' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'KnowledgeName' => ['description' => 'The name of the knowledge base.', 'type' => 'string', 'example' => '产品知识库', 'title' => ''], + 'KnowledgeId' => ['description' => 'The ID of the knowledge base.', 'type' => 'integer', 'format' => 'int64', 'example' => '68', 'title' => ''], + ], + 'description' => 'The collection of knowledge bases.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'description' => 'The collection of knowledge bases.', + 'title' => '', + ], + 'RagConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'RAG retrieval description', 'type' => 'string', 'example' => '知识库检索', 'title' => ''], + 'Enabled' => ['description' => 'Enable RAG retrieval', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'example' => '', + 'description' => 'The Retrieval-Augmented Generation (RAG) configuration.', + 'title' => '', + ], + ], + 'example' => '', + 'description' => 'The knowledge base configuration.', + 'title' => '', + ], + 'VersionId' => ['description' => 'Version ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '89', 'title' => ''], + 'VersionPublishTime' => ['description' => 'The most recent release time of the version.', 'type' => 'string', 'example' => '2024-01-15 10:30:00 ', 'title' => ''], + 'VersionPublishStatus' => ['description' => 'The release status of the version. 0 indicates Unreleased, 1 indicates Released, and 2 indicates Draft.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'VersionName' => ['description' => 'Version name.', 'type' => 'string', 'example' => '测试版本1', 'title' => ''], + 'VersionDesc' => ['description' => 'Version Description', 'type' => 'string', 'example' => '测试第一个版本', 'title' => ''], + ], + 'example' => '', + 'description' => 'The detailed data of the agent.', + 'title' => '', ], + 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Possible values:'."\n" + ."\n" + .'- **true**: The operation was successful.'."\n" + ."\n" + .'- **false**: Failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'title' => 'result', - 'type' => 'object', + 'description' => 'The details of the agent.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryAiVoiceAgentDetailNew', + 'description' => '## Usage notes'."\n" + ."\n" + .'- This API retrieves the details of a communication agent.'."\n" + ."\n" + .'- If you do not specify `BranchId` and `VersionId`, the API returns the configuration for the latest published version on the effective branch. If the effective branch only contains a draft version, no configuration is returned.'."\n" + ."\n" + .'- If you specify only `BranchId`, the API returns the configuration for the latest published version on the specified branch. If the specified branch only contains a draft version, no configuration is returned.'."\n" + ."\n" + .'- If you specify both `BranchId` and `VersionId`, the API returns the configuration for the specified version.'."\n" + ."\n" + .'- When `BranchDeployStatus` is `1` (branch deployed) and `VersionPublishStatus` is `1` (version published), imported outbound tasks use the configuration of this branch.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiVoiceAgentDetailNew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<CreateThirdSsoAgentResponse>\\n <Message>Success</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>123456</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</CreateThirdSsoAgentResponse>","errorExample":""}]', - 'title' => 'CreateThirdSsoAgent', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"742C9243-2870-B8D6-0C68-C12345AABBCC0\\",\\n \\"Message\\": \\"成功\\",\\n \\"Data\\": {\\n \\"AgentCallConfig\\": {\\n \\"StartWordType\\": 1,\\n \\"Prologue\\": \\"你好，这里是******。\\",\\n \\"VocabId\\": \\"afb2c43**********83e6df30551c11f7\\",\\n \\"TtsConfig\\": {\\n \\"VoiceCode\\": \\"V123ABC00\\",\\n \\"MixingTemplate\\": 1,\\n \\"BackgroundEnabled\\": true,\\n \\"TtsVolume\\": 88,\\n \\"TtsStyle\\": \\"longxiaoxia_v2p1\\",\\n \\"ResourceId\\": \\"voice-12345\\",\\n \\"CustomerAccountId\\": 75,\\n \\"VoiceType\\": true,\\n \\"MixingEnabled\\": true,\\n \\"TtsSpeed\\": 0,\\n \\"BackgroundSound\\": 17,\\n \\"BackgroundVolume\\": 1\\n },\\n \\"EventConfig\\": {\\n \\"MuteActive\\": true,\\n \\"SessionTimeout\\": 1000,\\n \\"CallAssistantHangup\\": false,\\n \\"CallAssistantRecognize\\": true,\\n \\"MuteDuration\\": 5,\\n \\"MuteHangupNum\\": 1\\n },\\n \\"RecordingFile\\": \\"/oss-file-key\\",\\n \\"TransferConfig\\": {\\n \\"SeatRouteName\\": \\"人工座席\\",\\n \\"CalledNumber\\": \\"123111122222\\",\\n \\"CustomerRouteCode\\": \\"123\\",\\n \\"CallingNumberType\\": 1,\\n \\"Enabled\\": false,\\n \\"CallerNumberType\\": 48,\\n \\"ExtraInfo\\": \\"Additional information for the agent\\",\\n \\"TransferType\\": 73,\\n \\"CallingNumber\\": \\"123111122222\\",\\n \\"CallerNumber\\": \\"123111122222\\",\\n \\"TransferBizId\\": \\"123\\",\\n \\"SeatRouteCode\\": \\"SEAT_CTI_A_NET\\",\\n \\"TransferContent\\": \\"提示语\\",\\n \\"FailureContent\\": \\"失败说明\\"\\n }\\n },\\n \\"AgentMode\\": 1,\\n \\"BranchDesc\\": \\"默认分支\\",\\n \\"BranchDeployStatus\\": 1,\\n \\"BranchId\\": 18,\\n \\"BranchName\\": \\"默认版本\\",\\n \\"Scene\\": \\"个人客户线索转化\\",\\n \\"AgentDemandConfig\\": {\\n \\"BasicTaskDescription\\": \\"进行产品营销，介绍优势特点\\",\\n \\"CoreTarget\\": \\"销售线索转化\\",\\n \\"AiGenerate\\": false,\\n \\"UserRole\\": \\"潜在客户\\",\\n \\"BusinessType\\": 1,\\n \\"SysRole\\": \\"销售\\"\\n },\\n \\"SummaryConfig\\": {\\n \\"MainPurpose\\": {\\n \\"MainPurposeEnum\\": [\\n {\\n \\"Description\\": \\"Description of the tag value\\",\\n \\"Value\\": \\"Tag value example\\",\\n \\"Id\\": \\"tag_12345\\"\\n }\\n ],\\n \\"MainPurposeName\\": \\"Customer inquiry handling\\",\\n \\"MainPurposeType\\": \\"ENUM\\",\\n \\"MainPurposeDescription\\": \\"Description of the main intent\\",\\n \\"Id\\": \\"123\\"\\n },\\n \\"CallResultTagConfig\\": {\\n \\"MappingTag\\": {\\n \\"key\\": \\"\\\\\\"CANCEL\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"tag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"test\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"desc\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"11\\\\\\\\\\\\\\"}\\\\\\"\\"\\n },\\n \\"DefaultTag\\": {\\n \\"Desc\\": \\"标签说明\\",\\n \\"Tag\\": \\"标签1\\"\\n }\\n },\\n \\"OutputTagConfig\\": [\\n {\\n \\"OutputTagDescription\\": \\"用户购买产品的意愿\\",\\n \\"OutputTagType\\": \\"ENUM\\",\\n \\"OutputTagEnum\\": [\\n {\\n \\"Description\\": \\"用户有较高购买意愿\\",\\n \\"Value\\": \\"高意愿\\",\\n \\"Id\\": \\"10\\"\\n }\\n ],\\n \\"OutputTagName\\": \\"购买意愿\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n },\\n \\"PhoneTagConfig\\": [\\n {\\n \\"PhoneTagType\\": \\"ENUM\\",\\n \\"PhoneTagName\\": \\"用户性别\\",\\n \\"PhoneTagRequired\\": false,\\n \\"Id\\": \\"123\\",\\n \\"PhoneTagSource\\": \\"MANUAL_CREATE\\",\\n \\"PhoneTagKey\\": \\"gender\\",\\n \\"PhoneTagEnum\\": [\\n {\\n \\"Description\\": \\"gender\\",\\n \\"Value\\": \\"male\\",\\n \\"Id\\": \\"123\\"\\n }\\n ]\\n }\\n ],\\n \\"AgentDesc\\": \\"日常测试使用。\\",\\n \\"AgentId\\": 3021893791,\\n \\"AgentName\\": \\"测试智能体\\",\\n \\"KnowledgeConfig\\": {\\n \\"KnowledgeIds\\": [\\n {\\n \\"KnowledgeName\\": \\"产品知识库\\",\\n \\"KnowledgeId\\": 68\\n }\\n ],\\n \\"RagConfig\\": {\\n \\"Description\\": \\"知识库检索\\",\\n \\"Enabled\\": false\\n }\\n },\\n \\"VersionId\\": 89,\\n \\"VersionPublishTime\\": \\"2024-01-15 10:30:00 \\",\\n \\"VersionPublishStatus\\": 1,\\n \\"VersionName\\": \\"测试版本1\\",\\n \\"VersionDesc\\": \\"测试第一个版本\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteOutboundTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryConversationDetailInfo' => [ + 'summary' => 'Gets call details.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'OutboundTaskId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The task ID. You can find this ID on the **call task management** page or get it by calling the [QueryAiCallTaskPage](~~2926799~~) operation.', 'type' => 'string', 'required' => true, 'example' => '138************', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'DetailId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The detail ID. You can find this ID in the upper-left corner of the page by navigating to **call task management** > **details** > **execution history** > **completed** > **call details**, or get it by calling the [QueryAiCallDetailPage](~~2926853~~) operation.', 'type' => 'string', 'required' => true, 'example' => '9662*************', 'title' => ''], + ], + [ + 'name' => 'BatchId', + 'in' => 'query', + 'schema' => ['description' => 'The batch ID. This ID is returned by the [ImportTaskNumberDatas](~~2926815~~) operation when you import callee data. You can view this ID on the **execution history** page by navigating to **call task management** > **details**.', 'type' => 'string', 'required' => true, 'example' => '139*********216', 'title' => ''], ], ], 'responses' => [ @@ -22771,46 +16196,211 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The status code message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757', 'title' => ''], 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'CallerPhone' => ['description' => 'The caller number.', 'type' => 'string', 'example' => '0571*******', 'title' => ''], + 'CallResult' => ['description' => 'The call result. Valid values:'."\n" + ."\n" + .'- `CALL_FORWARDING`: Call forwarding.'."\n" + ."\n" + .'- `INCOMING_CALL_BARRED`: Incoming call barred.'."\n" + ."\n" + .'- `CALL_REJECTED`: Call rejected.'."\n" + ."\n" + .'- `ANSWERED`: Answered by user.'."\n" + ."\n" + .'- `USER_BUSY`: Called party busy.'."\n" + ."\n" + .'- `POWERED_OFF`: Powered off.'."\n" + ."\n" + .'- `NO_USER_RESPONSE`: Out of service area.'."\n" + ."\n" + .'- `OPERATOR_BLOCK`: Blocked by carrier.'."\n" + ."\n" + .'- `OTHERS`: Other.'."\n" + ."\n" + .'- `SUSPEND`: Suspended.'."\n" + ."\n" + .'- `CANCEL`: Canceled by caller.'."\n" + ."\n" + .'- `INVALID_NUMBER`: Invalid number.'."\n" + ."\n" + .'- `UNAVAILABLE`: Temporarily unavailable.'."\n" + ."\n" + .'- `NETWORK_BUSY`: Network busy.'."\n" + ."\n" + .'- `NO_ANSWER`: No answer.', 'type' => 'string', 'example' => 'ANSWERED', 'title' => ''], + 'StatusMsg' => ['description' => 'The status message returned by the carrier.', 'type' => 'string', 'example' => '呼叫结束（双呼）', 'title' => ''], + 'StartCallTime' => ['description' => 'The timestamp when the call was initiated, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123123123123', 'title' => ''], + 'MajorIntent' => ['description' => 'The primary intent.', 'type' => 'string', 'example' => 'D', 'title' => ''], + 'CallId' => ['description' => 'The unique call ID.', 'type' => 'string', 'example' => '1231231231213^11231231231', 'title' => ''], + 'FailedReason' => ['description' => 'The failure reason.', 'type' => 'string', 'example' => '主动取消', 'title' => ''], + 'Duration' => ['description' => 'The duration of the call, in seconds. If the call was not connected, the value is 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'HangupDirection' => ['description' => 'The party that hung up. Valid values:'."\n" + ."\n" + .'- **0**: user.'."\n" + ."\n" + .'- **1**: assistant.', 'type' => 'string', 'example' => '用户', 'title' => ''], + 'StatusCode' => ['description' => 'The call status code. For more information, see [Call status codes](~~112804~~) for the voice service.', 'type' => 'string', 'example' => '200005', 'title' => ''], + 'CalledPhone' => ['description' => 'The called number.', 'type' => 'string', 'example' => '186******', 'title' => ''], + 'Variables' => [ + 'description' => 'A list of variables associated with the call task.', + 'type' => 'array', + 'items' => [ + 'description' => 'A variable from the call task.', + 'type' => 'object', + 'properties' => [ + 'Required' => ['description' => 'Indicates whether the variable is required. Valid values:'."\n" + ."\n" + .'- `true`: The variable is required.'."\n" + ."\n" + .'- `false`: The variable is optional.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'Id' => ['description' => 'The variable ID.', 'type' => 'string', 'example' => '22', 'title' => ''], + 'Key' => ['description' => 'The variable key.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Source' => ['type' => 'string', 'example' => '示例值', 'description' => '', 'title' => ''], + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'example' => '姓名', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'RecordingFileDownloadUrl' => ['description' => 'The download URL for the recording file. This parameter is returned only after the recording file is generated.', 'type' => 'string', 'example' => 'https://********', 'title' => ''], + 'ReleaseTime' => ['description' => 'The timestamp when the call ended, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '98', 'title' => ''], + 'PickUpTime' => ['description' => 'The timestamp when the call was answered, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1754617273000', 'title' => ''], + 'OutId' => ['description' => 'The business-specific ID that is passed in. You can use this unique ID to associate the call with your business.', 'type' => 'string', 'example' => 'bb3bc32d-54b8-49c4-80d3-61583417d22e'."\n", 'title' => ''], + 'ConversationRecord' => ['description' => 'The conversation record. The structure is a JSON array in which entries are sorted by time. Example:'."\n" + ."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "content":"Conversation content",'."\n" + .' "role":"Role", // Valid values: user, assistant'."\n" + .' }'."\n" + .']'."\n" + .'```', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "content": "111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>哎，你是谁？",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>你再说一遍。",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "哎，我没听清。",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "你在说什么？",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "您好，",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "我是**汽车总部销售服务顾问。",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>哎，那我是谁？",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "你在说什么呢？",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "抱歉打扰了，111先生。",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "祝您生活愉快！再见！",'."\n" + .' "role": "assistant"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'OutputTags' => [ + 'description' => 'A list of output tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single output tag.', + 'type' => 'object', + 'properties' => [ + 'OutputTagDescription' => ['description' => 'The tag description.', 'type' => 'string', 'example' => '评估客户对车型的兴趣和购买可能性', 'title' => ''], + 'OutputTagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '客户意向度', 'title' => ''], + 'OutputTagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '["高（非常积极，大概率转化）"]', 'title' => ''], + 'Id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '9ca2*****************************', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"F2051E18-FF3F-5C08-8D24-6F150D2AF757\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束（双呼）\\",\\n \\"StartCallTime\\": 123123123123123,\\n \\"MajorIntent\\": \\"D\\",\\n \\"CallId\\": \\"1231231231213^11231231231\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 16,\\n \\"HangupDirection\\": \\"用户\\",\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"186******\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"张三\\",\\n \\"Id\\": \\"22\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"示例值\\",\\n \\"Name\\": \\"姓名\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"https://********\\",\\n \\"ReleaseTime\\": 98,\\n \\"PickUpTime\\": 1754617273000,\\n \\"OutId\\": \\"bb3bc32d-54b8-49c4-80d3-61583417d22e\\\\n\\",\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"哎，我没听清。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"您好，\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我是**汽车总部销售服务顾问。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"我们最近推出了一款新车**，想了解一下您是否对这款车型感兴趣？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，那我是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"你在说什么呢？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"抱歉打扰了，111先生。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"祝您生活愉快！再见！\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n }\\\\n]\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高（非常积极，大概率转化）\\\\\\"]\\",\\n \\"Id\\": \\"9ca2*****************************\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Intelligent Agent Call Detail', + 'description' => '- This API retrieves call details. You can also view these details on the **call task management** > **details** > **execution history** > **completed** > **call details** page.'."\n" + ."\n" + .'- Before calling this API, make sure you have created a call task and imported called number data.'."\n" + ."\n" + .'- You can create a call task and import called number data either on the **call task management** page or by using the [CreateAiCallTask](~~2926796~~) and [ImportTaskNumberDatas](~~2926815~~) APIs.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryConversationDetailInfo'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryConversationDetailInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => null, ], - 'DeleteOuterAccount' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryConversationDetailInfoNew' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22818,428 +16408,500 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'OuterAccountId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The task ID. View the task ID in the **Call Task Management** console or call the [QueryAiCallTaskPage](~~2926799~~) operation to obtain the task ID.', 'type' => 'string', 'required' => true, 'example' => '138************', 'title' => ''], ], [ - 'name' => 'OuterAccountType', + 'name' => 'DetailId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'aliyun', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The task detail ID. View the task detail ID in the upper-left corner of the **Call Task Management** > **Details** > **Execution Records** > **Completed** > **Call Details** console, or call the [QueryAiCallDetailPage](~~2926853~~) operation to obtain the task detail ID.', 'type' => 'string', 'required' => false, 'example' => '9662*************', 'title' => ''], + ], + [ + 'name' => 'CallId', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'required' => false, 'example' => '1552********^1420********', 'title' => ''], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'The external business serial number reserved for external input. You can use a unique ID for business association.', 'type' => 'string', 'required' => false, 'example' => '123******', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'CallerPhone' => ['description' => 'The caller number.', 'type' => 'string', 'example' => '0571*******', 'title' => ''], + 'Options' => ['description' => 'The variable information used at runtime. The information is stored in this field as key-value pairs.', 'type' => 'string', 'example' => '{'."\n" + .' "date": "666",'."\n" + .' "phoneNumber": "777",'."\n" + .' "distance": "555",'."\n" + .' "mendian": "444",'."\n" + .' "sex": "男",'."\n" + .' "name": "111",'."\n" + .' "age": "222"'."\n" + .'}', 'title' => ''], + 'CallResult' => ['description' => 'The call result. Valid values:'."\n" + .'- CALL_FORWARDING: call forwarding.'."\n" + .'- INCOMING_CALL_BARRED: incoming call barred.'."\n" + .'- CALL_REJECTED: call rejected.'."\n" + .'- ANSWERED: the user answered.'."\n" + .'- USER_BUSY: the callee is busy.'."\n" + .'- POWERED_OFF: the phone is powered off.'."\n" + .'- NO_USER_RESPONSE: out of service area.'."\n" + .'- OPERATOR_BLOCK: blocked by the carrier.'."\n" + .'- OTHERS: other status.'."\n" + .'- SUSPEND: the phone is suspended.'."\n" + .'- CANCEL: the caller canceled.'."\n" + .'- INVALID_NUMBER: invalid number.'."\n" + .'- UNAVAILABLE: temporarily unavailable.'."\n" + .'- NETWORK_BUSY: network busy.'."\n" + .'- NO_ANSWER: no answer.', 'type' => 'string', 'example' => 'ANSWERED', 'title' => ''], + 'StatusMsg' => ['description' => 'The call status information returned by the carrier.', 'type' => 'string', 'example' => '呼叫结束（双呼）', 'title' => ''], + 'ConversationTurnCount' => ['description' => 'The number of conversation turns.', 'type' => 'integer', 'format' => 'int64', 'example' => '23', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '138************', 'title' => ''], + 'StartCallTime' => ['description' => 'The time when the call started. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1286987391', 'title' => ''], + 'StatusCode' => ['description' => 'The call status code. For more information, see [Call status codes](~~112804~~) in voice messaging.', 'type' => 'string', 'example' => '200005', 'title' => ''], + 'CalledPhone' => ['description' => 'The callee number.', 'type' => 'string', 'example' => '130********', 'title' => ''], + 'Variables' => [ + 'description' => 'The call variable information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The call variable information.', + 'type' => 'object', + 'properties' => [ + 'Required' => ['description' => 'Indicates whether the variable is required.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'example' => 'mike', 'title' => ''], + 'Id' => ['description' => 'The variable ID.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Key' => ['description' => 'The variable key.', 'type' => 'string', 'example' => 'name', 'title' => ''], + 'Source' => ['description' => 'The source.', 'type' => 'string', 'example' => 'source', 'title' => ''], + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'example' => 'user name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + 'RecordingFileDownloadUrl' => ['description' => 'The download URL of the recording file. This field is available only after a recording file is generated.', 'type' => 'string', 'example' => 'recording.oss.file', 'title' => ''], + 'PickUpTime' => ['description' => 'The time when the call was answered. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '12349732441', 'title' => ''], + 'ConversationRecord' => ['description' => 'The chat record information. The structure is a JSON array, and the chat records are sorted in chronological order. The structure is as follows:'."\n" + .'```json'."\n" + .'['."\n" + .' {'."\n" + .' "content":"聊天内容",'."\n" + .' "role":"角色",//Valid values: user and assistant (robot).'."\n" + .' }'."\n" + .']'."\n" + .'```.', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "content": "111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？",'."\n" + .' "role": "assistant"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>哎，你是谁？",'."\n" + .' "role": "user"'."\n" + .' },'."\n" + .' {'."\n" + .' "content": "<客户打断>你再说一遍。",'."\n" + .' "role": "user"'."\n" + .' }]', 'title' => ''], + 'Status' => ['description' => 'The agent status.', 'type' => 'integer', 'format' => 'int64', 'example' => '72', 'title' => ''], + 'ImportedTime' => ['description' => 'The import time. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '43', 'title' => ''], + 'EncryptionType' => ['type' => 'integer', 'format' => 'int64', 'example' => '28', 'description' => '', 'title' => ''], + 'MajorIntent' => ['description' => 'The major intent.', 'type' => 'string', 'example' => 'A', 'title' => ''], + 'CallId' => ['description' => 'The unique ID of the call.', 'type' => 'string', 'example' => '123*******^213******', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'string', 'example' => '1234******', 'title' => ''], + 'FailedReason' => ['description' => 'The failure reason.', 'type' => 'string', 'example' => '主动取消', 'title' => ''], + 'Duration' => ['description' => 'The call duration. The value is 0 if the call is not connected. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'HangupDirection' => ['description' => 'The hangup direction. Valid values:'."\n" + ."\n" + .'- **0**: the user.'."\n" + .'- **1**: the robot.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'DetailId' => ['description' => 'The task detail ID.', 'type' => 'string', 'example' => '1234*******', 'title' => ''], + 'ReleaseTime' => ['description' => 'The time when the call ended. This value is a UNIX timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'OutId' => ['description' => 'The external business serial number. You can use a unique ID for business association.', 'type' => 'string', 'example' => '123***', 'title' => ''], + 'OutputTags' => [ + 'description' => 'The output tag information.', + 'type' => 'array', + 'items' => [ + 'description' => 'The output tag information.', + 'type' => 'object', + 'properties' => [ + 'OutputTagDescription' => ['description' => 'The tag description.', 'type' => 'string', 'example' => '评估客户对车型的兴趣和购买可能性', 'title' => ''], + 'OutputTagName' => ['description' => 'The tag name.', 'type' => 'string', 'example' => '客户意向度', 'title' => ''], + 'OutputTagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => '["高（非常积极，大概率转化）"]', 'title' => ''], + 'Id' => ['description' => 'The tag ID.', 'type' => 'string', 'example' => '12', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + 'title' => '', + ], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: successful.'."\n" + .'- **false**: failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Call task details and call records', + 'summary' => 'Queries the details of a call task and call records.', + 'description' => '- You can call this operation to query call details. You can also view call details in the **Call Task Management** > **Details** > **Execution Records** > **Completed** > **Call Details** console.'."\n" + ."\n" + .'- Before calling this operation, make sure that you have created a call task and imported callee data.'."\n" + ."\n" + .'- If you do not have a created call task, create a call task and import callee data in the **Call Task Management** console, or call the [CreateAiCallTask](~~2926796~~) and [ImportTaskNumberDatas](~~2926815~~) operations to create a call task and import callee data.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteOuterAccountResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>true</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</DeleteOuterAccountResponse>","errorExample":""}]', - 'title' => 'DeleteOuterAccount', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Data\\": {\\n \\"CallerPhone\\": \\"0571*******\\",\\n \\"Options\\": \\"{\\\\n \\\\\\"date\\\\\\": \\\\\\"666\\\\\\",\\\\n \\\\\\"phoneNumber\\\\\\": \\\\\\"777\\\\\\",\\\\n \\\\\\"distance\\\\\\": \\\\\\"555\\\\\\",\\\\n \\\\\\"mendian\\\\\\": \\\\\\"444\\\\\\",\\\\n \\\\\\"sex\\\\\\": \\\\\\"男\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"111\\\\\\",\\\\n \\\\\\"age\\\\\\": \\\\\\"222\\\\\\"\\\\n}\\",\\n \\"CallResult\\": \\"ANSWERED\\",\\n \\"StatusMsg\\": \\"呼叫结束（双呼）\\",\\n \\"ConversationTurnCount\\": 23,\\n \\"TaskId\\": \\"138************\\",\\n \\"StartCallTime\\": 1286987391,\\n \\"StatusCode\\": \\"200005\\",\\n \\"CalledPhone\\": \\"130********\\",\\n \\"Variables\\": [\\n {\\n \\"Required\\": false,\\n \\"Value\\": \\"mike\\",\\n \\"Id\\": \\"123\\",\\n \\"Key\\": \\"name\\",\\n \\"Source\\": \\"source\\",\\n \\"Name\\": \\"user name\\"\\n }\\n ],\\n \\"RecordingFileDownloadUrl\\": \\"recording.oss.file\\",\\n \\"PickUpTime\\": 12349732441,\\n \\"ConversationRecord\\": \\"[\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"111您好，年龄222，性别男，我这边是**汽车的官方顾问，我们新出了一款车型为**；**已经上市了，售价**万元起，**分钟破*台，您看要不了解一下？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"assistant\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>哎，你是谁？\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"content\\\\\\": \\\\\\"<客户打断>你再说一遍。\\\\\\",\\\\n \\\\\\"role\\\\\\": \\\\\\"user\\\\\\"\\\\n }]\\",\\n \\"Status\\": 72,\\n \\"ImportedTime\\": 43,\\n \\"EncryptionType\\": 28,\\n \\"MajorIntent\\": \\"A\\",\\n \\"CallId\\": \\"123*******^213******\\",\\n \\"BatchId\\": \\"1234******\\",\\n \\"FailedReason\\": \\"主动取消\\",\\n \\"Duration\\": 30,\\n \\"HangupDirection\\": \\"0\\",\\n \\"DetailId\\": \\"1234*******\\",\\n \\"ReleaseTime\\": 7,\\n \\"OutId\\": \\"123***\\",\\n \\"OutputTags\\": [\\n {\\n \\"OutputTagDescription\\": \\"评估客户对车型的兴趣和购买可能性\\",\\n \\"OutputTagName\\": \\"客户意向度\\",\\n \\"OutputTagValue\\": \\"[\\\\\\"高（非常积极，大概率转化）\\\\\\"]\\",\\n \\"Id\\": \\"12\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', ], - 'DeleteQualityProject' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryHotlineInQueue' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'OuterGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'External skill group ID. ', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'OuterGroupType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'default' => '1', - ], + 'schema' => ['description' => 'External skill group type. ', 'docRequired' => true, 'example' => 'mybank', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Status code description. ', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Hotline agent data. ', 'example' => '{"n_online_now":10,"n_idle_now":3,"n_resttype_now":3,"n_acw_now":1}', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded. ', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Whether the API call succeeded. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, - ], - 'DeleteQualityRule' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"n_online_now\\\\\\":10,\\\\\\"n_idle_now\\\\\\":3,\\\\\\"n_resttype_now\\\\\\":3,\\\\\\"n_acw_now\\\\\\":1}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Hotline in Queue ', + 'summary' => 'Invoke QueryHotlineInQueue to obtain hotline agent data for a skill group by skill group ID. ', + 'responseParamsDescription' => 'n_online_now: Number of live support agents '."\n" + .'n_idle_now: Number of idle agents '."\n" + .'n_resttype_now: Number of agents on short break '."\n" + .'n_acw_now: Number of agents in post-processing ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryHotlineNumber' => [ + 'summary' => 'Query the hotline number configuration list by instance ID. Fuzzy query by hotline number is supported.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Id', + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default value: **1**.', 'example' => '1', 'format' => 'int32', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The value must be greater than **0**. Default value: **20**.', 'example' => '10', 'format' => 'int32', 'maximum' => '20', 'minimum' => '1', 'required' => true, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'HotlineNumber', + 'in' => 'query', + 'schema' => ['description' => 'The hotline number. Fuzzy query is supported.', 'example' => '0571****2211', 'required' => false, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => ['description' => 'The department ID.', 'example' => '2256****', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'GroupIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, + 'description' => 'The list of skill groups.', + 'items' => ['description' => 'The skill group ID. Use this together with the skill group category ID.', 'example' => '["6083****","6084****"]', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE339D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Status code description.', 'example' => 'OK', 'title' => '', 'type' => 'string'], 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'description' => 'Hotline number configuration information.', + 'properties' => [ + 'TotalCount' => ['description' => 'Total amount of data.', 'example' => '123', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'PageSize' => ['description' => 'Page size.', 'example' => '10', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'CurrentPage' => ['description' => 'Current page.', 'example' => '1', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'HotlineNumList' => [ + 'description' => 'Number list.', + 'items' => [ + 'description' => 'Number list.', + 'properties' => [ + 'FlowId' => ['description' => 'Incoming call flow ID.', 'example' => '12', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Description' => ['description' => 'Number description.', 'example' => '测试', 'title' => '', 'type' => 'string'], + 'OutboundEnabled' => ['description' => 'Indicates whether the number is used for outbound calls.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + 'CalloutAllDepartment' => ['description' => 'Outbound calls apply to all departments.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + 'FlowName' => ['description' => 'Inbound flow name.', 'example' => '测试流程', 'title' => '', 'type' => 'string'], + 'CalloutRangeList' => [ + 'description' => 'List of departments for which outbound calls are effective.', + 'items' => [ + 'description' => 'List of departments for which outbound calls are effective.', + 'properties' => [ + 'GroupDOList' => [ + 'description' => 'The skill group list.', + 'items' => [ + 'description' => 'The skill group list.', + 'properties' => [ + 'GroupName' => ['description' => 'The skill group name.', 'example' => '技能组A', 'title' => '', 'type' => 'string'], + 'GroupId' => ['description' => 'The skill group ID.', 'example' => '6083****', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'DepartmentName' => ['description' => 'The department name.', 'example' => '部门A', 'title' => '', 'type' => 'string'], + 'DepartmentId' => ['description' => 'Department ID. ', 'example' => '2256****', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'HotlineNumber' => ['description' => 'Hotline number. ', 'example' => '0571****2211', 'title' => '', 'type' => 'string'], + 'EvaluationStatus' => ['description' => 'Satisfaction status. Valid values: '."\n" + .'- **0**: Neither inbound nor outbound calls are enabled. '."\n" + .'- **1**: Inbound calls are enabled. '."\n" + .'- **2**: Outbound calls are enabled. '."\n" + .'- **3**: Both inbound and outbound calls are enabled. ', 'example' => '0', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + 'Sp' => ['description' => 'Carrier. ', 'example' => '电信', 'title' => '', 'type' => 'string'], + 'Location' => ['description' => 'Number location. ', 'example' => '浙江杭州', 'title' => '', 'type' => 'string'], + 'InBoundEnabled' => ['description' => 'Indicates whether the number is used for inbound calls.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A value of Success indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE339D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 123,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"HotlineNumList\\": [\\n {\\n \\"FlowId\\": 12,\\n \\"Description\\": \\"测试\\",\\n \\"OutboundEnabled\\": true,\\n \\"CalloutAllDepartment\\": true,\\n \\"FlowName\\": \\"测试流程\\",\\n \\"CalloutRangeList\\": [\\n {\\n \\"GroupDOList\\": [\\n {\\n \\"GroupName\\": \\"技能组A\\",\\n \\"GroupId\\": 0\\n }\\n ],\\n \\"DepartmentName\\": \\"部门A\\",\\n \\"DepartmentId\\": 0\\n }\\n ],\\n \\"HotlineNumber\\": \\"0571****2211\\",\\n \\"EvaluationStatus\\": 0,\\n \\"Sp\\": \\"电信\\",\\n \\"Location\\": \\"浙江杭州\\",\\n \\"InBoundEnabled\\": true\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Hotline Number Configuration List', + 'description' => 'The hotline number configuration includes information such as the hotline number, number location, carrier, and whether it is used for incoming calls. For details, see [Return Parameters](#api-detail-40).'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: 100 times per second.'."\n" + .'- API invocation frequency: 100 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryHotlineNumber'], + ], ], - 'responseDemo' => null, + 'ramActions' => [], ], - 'EditQualityProject' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryOutboundTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', 'default' => '', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CheckFreqType', + 'name' => 'StartDate', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ProjectVersion', + 'name' => 'EndDate', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ScopeType', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'TimeRangeStart', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'TimeRangeEnd', + 'name' => 'SkillGroup', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AnalysisIds', + 'name' => 'Ani', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'DepList', + 'name' => 'Status', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'maxItems' => 3, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'GroupList', + 'name' => 'GroupName', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'maxItems' => 3, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ServicerList', + 'name' => 'DepartmentId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => false, - 'maxItems' => 3, - ], + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ChannelTouchType', + 'name' => 'InstanceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '20', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -23247,232 +16909,287 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'Version' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ProjectId' => [ - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CurrentPage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TotalResults' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GroupName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SkillGroup' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Creator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndDate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'StartDate' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CallerNum' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'BuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Type' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Model' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ExtAttrs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RetryInterval' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'RetryTime' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Modifier' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"HttpStatusCode\\": \\"\\",\\n \\"Data\\": {\\n \\"PageSize\\": \\"\\",\\n \\"CurrentPage\\": \\"\\",\\n \\"TotalResults\\": \\"\\",\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"GroupName\\": \\"\\",\\n \\"SkillGroup\\": 0,\\n \\"Description\\": \\"\\",\\n \\"EndTime\\": \\"\\",\\n \\"GmtModified\\": 0,\\n \\"StartTime\\": \\"\\",\\n \\"Creator\\": \\"\\",\\n \\"EndDate\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"StartDate\\": \\"\\",\\n \\"CallerNum\\": \\"\\",\\n \\"BuId\\": 0,\\n \\"Type\\": 0,\\n \\"GmtCreate\\": 0,\\n \\"Model\\": 0,\\n \\"ExtAttrs\\": \\"\\",\\n \\"RetryInterval\\": 0,\\n \\"RetryTime\\": 0,\\n \\"DepartmentId\\": 0,\\n \\"Id\\": 0,\\n \\"Modifier\\": \\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'EditQualityRule' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QuerySkillGroups' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The current page number. The value must be greater than **0**. Default Value: **1**.', 'example' => '1', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'RuleTag', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Page size. The value must be greater than **0**. Default value: **20**.', 'example' => '20', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'MatchType', - 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'QualityRuleId', - 'in' => 'formData', + 'name' => 'ChannelType', + 'in' => 'query', 'schema' => [ + 'description' => 'The channel type of the skill group. Valid values:'."\n" + ."\n" + .'- **0**: Returns all skill groups.'."\n" + .'- **1**: Hotline skill group.'."\n" + .'- **2**: Online skill group.'."\n" + .'- **3**: Online and hotline skill group.'."\n" + .'- **4**: Ticket skill group.'."\n" + .'- **5**: Hotline and ticket skill group.'."\n" + .'- **6**: Online and ticket skill group.'."\n" + .'- **7**: Online, hotline, and ticket skill group.', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'title' => '', 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, + 'enum' => ['1', '2', '4'], ], ], [ - 'name' => 'KeyWords', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - 'required' => true, - 'maxItems' => 3, - ], + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => ['description' => 'The department ID.', 'example' => '1023****', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'OnePageSize' => ['description' => 'Number of items per page.', 'example' => '20', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages.', 'example' => '4', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'CurrentPage' => ['description' => 'Current page.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TotalResults' => ['description' => 'Total number of records.', 'example' => '76', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Data' => [ + 'description' => 'Data.', + 'items' => [ + 'description' => 'Data information.', + 'properties' => [ + 'Description' => ['description' => 'Skill group description.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'SkillGroupName' => ['description' => 'Skill group name.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'DisplayName' => ['description' => 'Skill group display name.', 'example' => '自动化技能组', 'type' => 'string', 'title' => ''], + 'SkillGroupId' => ['description' => 'Skill group ID.', 'example' => '123456', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelType' => ['description' => 'Skill group channel type.', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified parameter is invalid.', - 'errorCode' => 'InvalidParameter', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 400 => [ + ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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 \\"Description\\": \\"自动化技能组\\",\\n \\"SkillGroupName\\": \\"自动化技能组\\",\\n \\"DisplayName\\": \\"自动化技能组\\",\\n \\"SkillGroupId\\": 123456,\\n \\"ChannelType\\": 2\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query Skill Groups', + 'summary' => 'Queries the skill group list of the Cloud Customer Service System by instance ID.', + 'description' => 'This API allows you to query information such as the display name, description, channel type, and ID of skill groups. For details, see [Response Parameters](#api-detail-40).'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 1000 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-21T09:25:21.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'EditQualityRuleTag' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTaskDetail' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'OutboundTaskId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'StatusList', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndReasonList', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'SkillGroup', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + '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' => 'PriorityList', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Ani', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Dnis', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Sid', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'DepartmentIdList', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'title' => '', 'example' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'AnalysisTypes', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], - 'Name' => [ - 'type' => 'string', - 'required' => false, - ], - ], - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '0', 'default' => '1', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -23480,83 +17197,162 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CurrentPage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TotalResults' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'List' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'OutboundTaskId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'SkillGroup' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'OutboundNum' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Priority' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'GmtModified' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'BuId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'MemberId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'GmtCreate' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'EndReason' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'Dnis' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ExtAttrs' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MemberName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RetryTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DepartmentId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Id' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], + 'ServicerId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Ani' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"HttpStatusCode\\": \\"\\",\\n \\"Data\\": {\\n \\"PageSize\\": \\"\\",\\n \\"CurrentPage\\": \\"\\",\\n \\"TotalResults\\": \\"\\",\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"OutboundTaskId\\": 0,\\n \\"SkillGroup\\": 0,\\n \\"OutboundNum\\": 0,\\n \\"Priority\\": 0,\\n \\"GmtModified\\": 0,\\n \\"BuId\\": 0,\\n \\"MemberId\\": 0,\\n \\"GmtCreate\\": 0,\\n \\"ServicerName\\": \\"\\",\\n \\"EndReason\\": 0,\\n \\"Dnis\\": \\"\\",\\n \\"ExtAttrs\\": \\"\\",\\n \\"MemberName\\": \\"\\",\\n \\"RetryTime\\": \\"\\",\\n \\"DepartmentId\\": 0,\\n \\"Id\\": 0,\\n \\"ServicerId\\": 0,\\n \\"Ani\\": \\"\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"\\",\\n \\"Success\\": \\"\\"\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'EncryptPhoneNum' => [ - 'summary' => '热线号码加密', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTickets' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '实例Id', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Instance ID.'."\n" + ."\n" + .'Log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview) and view the instance ID in **Instance Management**.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PhoneNum', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '130****0000', - 'required' => true, - 'title' => '号码明文', - 'type' => 'string', - ], + 'name' => 'CaseId', + 'in' => 'formData', + 'schema' => ['description' => 'Ticket ID.', 'example' => '223468****', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'CaseType', + 'in' => 'formData', + 'schema' => ['description' => 'Ticket type code (assigned by the system).', 'example' => '1223', 'format' => 'int32', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'CaseStatus', + 'in' => 'formData', + 'schema' => ['description' => 'Ticket status code.', 'example' => '2', 'format' => 'int32', 'maximum' => '9223372036854775807', 'minimum' => '-100000', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'SrType', + 'in' => 'formData', + 'schema' => ['description' => 'Template ID.', 'example' => '29506', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'formData', + 'schema' => ['description' => 'Job status.', 'example' => '3', 'format' => 'int32', 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'ChannelId', + 'in' => 'formData', + 'schema' => ['description' => 'Channel ID.', 'example' => '02acfefd3fa14049826ac1a89e1xxxxx', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ChannelType', + 'in' => 'formData', + 'schema' => ['description' => 'Channel Type. Valid values:'."\n" + .'- **0**: Not filled in'."\n" + .'- **1**: Hotline'."\n" + .'- **2**: Online', 'example' => '1', 'format' => 'int32', 'maximum' => '9223372036854775807', 'minimum' => '-10000000', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TouchId', + 'in' => 'formData', + 'schema' => ['description' => 'Touch ID.', 'example' => '15030609', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'DealId', + 'in' => 'formData', + 'schema' => ['description' => 'Assignee ID.', 'example' => '123456', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '-1', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Additional information.', 'example' => '无', 'required' => false, 'type' => 'object', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'Page size. Default Value: **10**.', 'example' => '10', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => ['description' => 'Current page. Default Value: **1**.', 'example' => '1', 'format' => 'int32', 'maximum' => '5000', 'minimum' => '0', 'required' => false, 'type' => 'integer', 'default' => '0', 'title' => ''], ], ], 'responses' => [ @@ -23564,64 +17360,36 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '错误信息', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '20nJ****/9Fl/kxx/***7', - 'title' => '加密后密文', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Ticket information.', 'example' => '{ "totalResults":1 "previousPage":1 "data":[ 0:{ "serviceType":1 "lastUrgeTime":0 "queueId":0 "sopCateId":252011 "totalUrgeMemo":"" "taskGmtModified":0 "departmentId":10 "groupId":0 "channelType":1 "questionInfo":"" "templateId":0 "deadLine":0 "srType":30701 "caseId":2000000001165962}', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{ \\\\\\"totalResults\\\\\\":1 \\\\\\"previousPage\\\\\\":1 \\\\\\"data\\\\\\":[ 0:{ \\\\\\"serviceType\\\\\\":1 \\\\\\"lastUrgeTime\\\\\\":0 \\\\\\"queueId\\\\\\":0 \\\\\\"sopCateId\\\\\\":252011 \\\\\\"totalUrgeMemo\\\\\\":\\\\\\"\\\\\\" \\\\\\"taskGmtModified\\\\\\":0 \\\\\\"departmentId\\\\\\":10 \\\\\\"groupId\\\\\\":0 \\\\\\"channelType\\\\\\":1 \\\\\\"questionInfo\\\\\\":\\\\\\"\\\\\\" \\\\\\"templateId\\\\\\":0 \\\\\\"deadLine\\\\\\":0 \\\\\\"srType\\\\\\":30701 \\\\\\"caseId\\\\\\":2000000001165962}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query Tickets', + 'summary' => 'Invoke the QueryTickets API to query ticket information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"20nJ****/9Fl/kxx/***7\\"\\n}","errorExample":""},{"type":"xml","example":"<EncryptPhoneNumResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>xxxx</Message>\\n <Data>20nJ****/9Fl/kxx/***7</Data>\\n</EncryptPhoneNumResponse>","errorExample":""}]', - 'title' => 'EncryptPhoneNum', + 'ramActions' => [], ], - 'FetchCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'QueryTouchList' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23629,1988 +17397,1257 @@ [ 'BearerToken' => [], ], + [ + 'PrivateKey' => [], + ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). '."\n", 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'TouchId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', + 'description' => 'List of touch IDs for term query.', + 'items' => ['description' => 'Touch ID.', 'example' => '10****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'string', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceId', + 'name' => 'ChannelId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', + 'description' => 'List of session IDs for term query.', + 'items' => ['description' => 'Session ID.', 'example' => '846a7a4aa2524186b899a6ba02****', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AccountName', + 'name' => 'ChannelType', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', + 'description' => 'Channel Type.', + 'items' => ['description' => 'Channel Type. Valid values:'."\n" + .'- **1**: Hotline.'."\n" + .'- **2**: Online.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + 'enum' => ['1', '2'], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CallId', + 'name' => 'TouchType', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', + 'description' => 'Touch type.', + 'items' => ['description' => 'Touch type. Valid values:'."\n" + .'- **1**: Active touch (outbound call).'."\n" + .'- **2**: Passive touch (inquiry).', 'example' => '2', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 10, 'required' => false, - 'type' => 'string', + 'type' => 'array', + 'enum' => ['1', '2'], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'JobId', + 'name' => 'MemberId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', + 'description' => 'List of membership IDs to query.', + 'items' => ['description' => 'Membership ID.', 'example' => '1000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'string', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ConnectionId', + 'name' => 'MemberName', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', + 'description' => 'A list of membership names to query.', + 'items' => ['description' => 'Membership name.', 'example' => 'zhangsan', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'string', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'HoldConnectionId', + 'name' => 'ServicerId', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0', + 'description' => 'A list of service agent IDs to query.', + 'items' => ['description' => 'Service agent ID.', 'example' => '70020', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'string', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'ServicerName', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'description' => 'List of service agent names to query.', + 'items' => ['description' => 'Service agent name.', 'example' => 'lisi', 'required' => false, 'type' => 'string', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', - ], - 'GetAgentById' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'QueueId', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'List of inbound skill group IDs. ', + 'items' => ['description' => 'Skill group ID for incoming calls.', 'example' => '10000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, + 'required' => false, + 'type' => 'array', + 'title' => '', + 'example' => '', + ], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'EvaluationStatus', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, + 'description' => 'Evaluation status.', + 'items' => ['description' => 'Evaluation status. Valid values:'."\n" + .'- **-1**: Evaluation not initiated.'."\n" + .'- **0**: Not evaluated.'."\n" + .'- **1**: Evaluated.', 'example' => '0', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + 'enum' => ['-1', '0', '1'], + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AgentId', + 'name' => 'EvaluationLevel', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', + 'description' => 'Satisfaction level.', + 'items' => ['description' => 'Satisfaction level. Valid values:'."\n" + .'- **2**: Level 2 satisfaction.'."\n" + .'- **3**: Level 3 satisfaction.'."\n" + .'- **4**: Level 4 satisfaction.'."\n" + .'- **5**: Level 5 satisfaction.', 'example' => '5', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + 'enum' => ['2', '3', '4', '5'], + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'EvaluationScore', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'ForeignNick' => [ - 'type' => 'string', - ], - 'ServicerType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RealName' => [ - 'type' => 'string', - ], - 'AgentId' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ForeignKey' => [ - 'type' => 'string', - ], - 'ShowName' => [ - 'type' => 'string', - ], - 'CreateUserName' => [ - 'type' => 'string', - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], + 'description' => 'Satisfaction score. ', + 'items' => ['description' => 'Satisfaction score. Valid values: '."\n" + .'- **1**: Very dissatisfied. '."\n" + .'- **2**: Dissatisfied. '."\n" + .'- **3**: Neutral. '."\n" + .'- **4**: Satisfied. '."\n" + .'- **5**: Very satisfied. '."\n", 'example' => '5', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 10, + 'required' => false, + 'type' => 'array', + 'enum' => ['1', '2', '3', '4', '5'], + 'title' => '', + 'example' => '', ], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + [ + 'name' => 'FirstTimeStart', + 'in' => 'formData', + 'schema' => ['description' => 'The left boundary of the time range for session start. UNIX timestamp format (unit: ms).', 'example' => '1614596400000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, - ], - 'GetHotlineRuntimeInfo' => [ - 'summary' => '获取热线当前信息', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'FirstTimeEnd', + 'in' => 'formData', + 'schema' => ['description' => 'The right boundary of the time range for session start. The value is a UNIX timestamp in milliseconds.', 'example' => '1614599400000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'BearerToken' => [], + 'name' => 'CloseTimeStart', + 'in' => 'formData', + 'schema' => ['description' => 'The left boundary of the time range for session end. The value is a UNIX timestamp in milliseconds.', 'example' => '1614600400000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'name' => 'CloseTimeEnd', + 'in' => 'formData', + 'schema' => ['description' => 'The right boundary of the time range for session end. The value is a UNIX timestamp in milliseconds.', 'example' => '1614600500000', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123@****.com', - 'required' => true, - 'title' => '账号名', - 'type' => 'string', - ], + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'Number of entries per page. The value must be greater than **0**. Default value: **20**. ', 'example' => '20', 'format' => 'int32', 'maximum' => '500', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '50', 'title' => ''], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'formData', + 'schema' => ['description' => 'Current page. The value must be greater than **0**. Default Value: **1**.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'title' => '错误信息', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '', - 'title' => '数据结果', + 'ResultData' => [ + 'description' => 'Data result. ', + 'properties' => [ + 'Empty' => ['description' => 'Indicates whether the result is empty. ', 'example' => 'false', 'type' => 'boolean', 'title' => ''], + 'OnePageSize' => ['description' => 'Page size. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TotalPage' => ['description' => 'Total number of pages. ', 'example' => '4', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'CurrentPage' => ['description' => 'Current page number. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'PreviousPage' => ['description' => 'Previous page number. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TotalResults' => ['description' => 'Total number of query results. ', 'example' => '100', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Data' => [ + 'description' => 'Data. ', + 'items' => [ + 'description' => 'Returned data. ', + 'properties' => [ + 'ParentTouchId' => ['description' => 'Parent contact ID. ', 'example' => '0', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'DepId' => ['description' => 'Department ID.', 'example' => '100', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'GmtModified' => ['description' => 'Update Time. UNIX timestamp format (unit: milliseconds).', 'example' => '1611207979000', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'UserTouchId' => ['description' => 'User touch ID.', 'example' => '1386****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CommonQueueName' => ['description' => 'Skill group name.', 'example' => '测试1', 'type' => 'string', 'title' => ''], + 'ChannelId' => ['description' => 'Session ID.', 'example' => '4f8807a9de024507a3090b5b66a8****', 'type' => 'string', 'title' => ''], + 'TouchId' => ['description' => 'Touch ID.', 'example' => '1386****', 'type' => 'string', 'title' => ''], + 'MemberId' => ['description' => 'Membership ID.', 'example' => '6400665****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ServicerName' => ['description' => 'Service agent name.', 'example' => '1390000****', 'type' => 'string', 'title' => ''], + 'Feedback' => ['description' => 'Feedback.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'TouchType' => ['description' => 'Touch type. Valid values:'."\n" + .'- **1**: Active touch.'."\n" + .'- **2**: Passive touch.', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Status' => ['description' => 'Contact status. Valid values: '."\n" + .'- **1**: Incoming call received. '."\n" + .'- **2**: Agent has joined. '."\n" + .'- **3**: In conversation. '."\n" + .'- **4**: Ended. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'SwitchUser' => ['description' => 'Change owner list. ', 'example' => 'null', 'type' => 'string', 'title' => ''], + 'FirstTime' => ['description' => 'Conversation pickup time, in UNIX timestamp format (unit: milliseconds). ', 'example' => '1611209971000', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'FromId' => ['description' => 'Conversation initiator. ', 'example' => '6400665****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'QueueId' => ['description' => 'Skill group ID. ', 'example' => '111', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ExtAttrsString' => ['description' => 'Large object. ', 'type' => 'object', 'title' => '', 'example' => ''], + 'TouchTime' => ['description' => 'Conversation duration (unit: seconds). ', 'example' => '111', 'type' => 'string', 'title' => ''], + 'ToId' => ['description' => 'Conversation recipient. ', 'example' => '67****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'BuId' => ['description' => 'Tenant ID. ', 'example' => '905', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'GmtCreate' => ['description' => 'Creation Time, in UNIX timestamp format (unit: milliseconds).', 'example' => '1611209971000', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'CloseTime' => ['description' => 'Session end time. UNIX timestamp format (unit: milliseconds).', 'example' => '1611207976000', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ExtAttrs' => [ + 'description' => 'Extension fields.', + 'properties' => [ + 'EvaluationScore' => ['description' => 'Satisfaction rating. Valid values:'."\n" + .'- **1**: Very dissatisfied.'."\n" + .'- **2**: Dissatisfied.'."\n" + .'- **3**: Neutral.'."\n" + .'- **4**: Satisfied.'."\n" + .'- **5**: Very satisfied.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'OnlineJoinRespInterval' => ['description' => 'Duration until first response (unit: seconds).', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'Dnis' => ['description' => 'For outbound calls, this is the called number. For inbound calls, this is also the called number.', 'example' => '05712688****', 'type' => 'string', 'title' => ''], + 'OnlineSessionSource' => ['description' => 'Online session source.', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'EvaluationStatus' => ['description' => 'Evaluation status. Valid values:'."\n" + .'- **-1**: Evaluation not initiated.'."\n" + .'- **0**: Not evaluated.'."\n" + .'- **1**: Evaluated.', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'EvaluationLevel' => ['description' => 'Satisfaction Level. Valid values: '."\n" + .'- **2**: Level 2 satisfaction. '."\n" + .'- **3**: Level 3 satisfaction. '."\n" + .'- **4**: Level 4 satisfaction. '."\n" + .'- **5**: Level 5 satisfaction. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'OutCallRouteNumber' => ['description' => 'Outbound call caller number. ', 'example' => '05712688****', 'type' => 'string', 'title' => ''], + 'Ani' => ['description' => 'Inbound call caller number. ', 'example' => '187****0000', 'type' => 'string', 'title' => ''], + 'EvaluationSolution' => ['description' => 'Evaluation solution. ', 'example' => '0', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'TouchEndReason' => ['description' => 'End reason. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'MemberName' => ['description' => 'Membership name. ', 'example' => '访客', 'type' => 'string', 'title' => ''], + 'ServicerId' => ['description' => 'Service agent ID. ', 'example' => '67****', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'ChannelType' => ['description' => 'Contact channel. ', 'example' => '1', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + 'TouchContent' => ['description' => 'The reason why the session ended. Valid values: '."\n" + .'- **0**: Unknown. '."\n" + .'- **1**: Contact failed. '."\n" + .'- **2**: Terminated by customer. '."\n" + .'- **3**: Terminated by agent. '."\n" + .'- **4**: Call abnormally interrupted. '."\n" + .'- **5**: Terminated due to change owner. '."\n" + .'- **6**: Terminated by system. '."\n", 'example' => '1', 'type' => 'string', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'type' => 'array', + 'title' => '', + 'example' => '', + ], + 'NextPage' => ['description' => 'The page number of the next page. ', 'example' => '2', 'format' => 'int32', 'type' => 'integer', 'title' => ''], + ], 'type' => 'object', + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '接口调用是否成功', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => '865658FD-80DE-5D49-ABEB-F3CC9863F4F1', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. ', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. '."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'Schema of Response', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"buId\\": 905,\\n \\"phoneToken\\": \\"roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIw****=\\",\\n \\"isNeedWorkShift\\": false,\\n \\"servicerId\\": 741018,\\n \\"accConfigUrl\\": \\"pre-acc-cs-public.alibaba-inc.com\\",\\n \\"agentBasicCode\\": \\"AgentCheckout\\",\\n \\"startWorkToReady\\": true,\\n \\"servicerDn\\": \\"2000000001904123\\",\\n \\"isMaster\\": \\"1\\",\\n \\"tenantId\\": 2001,\\n \\"depId\\": 1139139,\\n \\"accTenantId\\": 2001,\\n \\"phoneData\\": \\"{\\\\\\"timeStamp\\\\\\":164240****,\\\\\\"expireTime\\\\\\":164257****,\\\\\\"dn\\\\\\":\\\\\\"200000000190****\\\\\\",\\\\\\"source\\\\\\":\\\\\\"xspace\\\\\\",\\\\\\"serviceId\\\\\\":741018}\\",\\n \\"agentBasicDesc\\": \\"坐席签出状态\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetHotlineRuntimeInfoResponse>\\n <Data>\\n <buId>905</buId>\\n <phoneToken>roESVzzgD1ytmG0W6nMkWinI6fbpKovm14fBhA0NsYPyi/srX/G0SvNB2z96AYiqy1vxQHiaFOdZSxtsAubdgr2kjs2yas7COO5dukQpsOLq9iNI4U6sKlcvaBi8xsyUr/hyqCdTVZDcYCOq0lH6eeNIQK/f7/gWqIwDXiWfN2g=</phoneToken>\\n <isNeedWorkShift>false</isNeedWorkShift>\\n <servicerId>741018</servicerId>\\n <accConfigUrl>pre-acc-cs-public.alibaba-inc.com</accConfigUrl>\\n <agentBasicCode>AgentCheckout</agentBasicCode>\\n <startWorkToReady>true</startWorkToReady>\\n <servicerDn>2000000001904123</servicerDn>\\n <isMaster>1</isMaster>\\n <tenantId>2001</tenantId>\\n <depId>1139139</depId>\\n <accTenantId>2001</accTenantId>\\n <phoneData>{\\"timeStamp\\":1642402907,\\"expireTime\\":1642575707,\\"dn\\":\\"2000000001904123\\",\\"source\\":\\"xspace\\",\\"serviceId\\":741018}</phoneData>\\n <agentBasicDesc>坐席签出状态</agentBasicDesc>\\n </Data>\\n <Success>true</Success>\\n</GetHotlineRuntimeInfoResponse>","errorExample":""}]', - 'title' => 'GetHotlineRuntimeInfo', + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResultData\\": {\\n \\"Empty\\": false,\\n \\"OnePageSize\\": 2,\\n \\"TotalPage\\": 4,\\n \\"CurrentPage\\": 1,\\n \\"PreviousPage\\": 2,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ParentTouchId\\": 0,\\n \\"DepId\\": 100,\\n \\"GmtModified\\": 1611207979000,\\n \\"UserTouchId\\": 0,\\n \\"CommonQueueName\\": \\"测试1\\",\\n \\"ChannelId\\": \\"4f8807a9de024507a3090b5b66a8****\\",\\n \\"TouchId\\": \\"1386****\\",\\n \\"MemberId\\": 0,\\n \\"ServicerName\\": \\"1390000****\\",\\n \\"Feedback\\": \\"xxxx\\",\\n \\"TouchType\\": 2,\\n \\"Status\\": 1,\\n \\"SwitchUser\\": \\"null\\",\\n \\"FirstTime\\": 1611209971000,\\n \\"FromId\\": 0,\\n \\"QueueId\\": 111,\\n \\"ExtAttrsString\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"TouchTime\\": \\"111\\",\\n \\"ToId\\": 0,\\n \\"BuId\\": 905,\\n \\"GmtCreate\\": 1611209971000,\\n \\"CloseTime\\": 1611207976000,\\n \\"ExtAttrs\\": {\\n \\"EvaluationScore\\": 1,\\n \\"OnlineJoinRespInterval\\": 1,\\n \\"Dnis\\": \\"05712688****\\",\\n \\"OnlineSessionSource\\": 0,\\n \\"EvaluationStatus\\": 1,\\n \\"EvaluationLevel\\": 2,\\n \\"OutCallRouteNumber\\": \\"05712688****\\",\\n \\"Ani\\": \\"187****0000\\",\\n \\"EvaluationSolution\\": 0\\n },\\n \\"TouchEndReason\\": 2,\\n \\"MemberName\\": \\"访客\\",\\n \\"ServicerId\\": 0,\\n \\"ChannelType\\": 1,\\n \\"TouchContent\\": \\"1\\"\\n }\\n ],\\n \\"NextPage\\": 2\\n },\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"865658FD-80DE-5D49-ABEB-F3CC9863F4F1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query contact data ', + 'summary' => 'Query contact data by instance, list of contact IDs, list of session IDs, and so on. ', + 'description' => 'This API allows you to query contact data such as contact status, session recipient, agent name, contact channel, satisfaction rating, and evaluation status. For details, see [Response parameters](#api-detail-40). '."\n" + ."\n" + .'### Queries per second (QPS) limit '."\n" + .'- Per-user invocation frequency: No Rate Limiting. '."\n" + .'- API frequency: 50 queries per second (QPS). '."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered. ', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2021-05-14T11:26:46.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-05-14T06:25:24.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetHotlineWaitingNumber' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveAgentFromSkillGroup' => [ + 'summary' => 'Remove agent accounts from a skill group by specifying the skill group and agent IDs.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-78v1gnp97002', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'InstanceId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Skill group ID. '."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and view the **SkillGroupId** in the response parameters to obtain the skill group ID. ', 'example' => '1146****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'AccountName', + 'name' => 'AgentIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', + 'description' => 'A list of agent IDs.', + 'items' => ['description' => 'Agent ID. '."\n" + ."\n" + .'You can invoke the [GetAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-getagent) API and view the **AgentId** in the response parameters to obtain the agent ID. ', 'example' => '["6083****","6084****"]', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], 'required' => true, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => ' '."\n" - .'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => '', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], 'Data' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', + 'description' => 'Returned data.', + 'properties' => [ + 'SuccessCount' => ['description' => 'The number of agents successfully removed.', 'example' => '2', 'format' => 'int32', 'title' => '', 'type' => 'integer'], + ], + 'title' => '', + 'type' => 'object', + 'example' => '', ], + 'Code' => ['description' => 'The status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"SuccessCount\\": 2\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Remove Agent Accounts from a Skill Group', + 'description' => '- If you need to provide agent or skill group information, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + .'- You can invoke [ListAgentBySkillGroupId](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-listagentbyskillgroupid) to retrieve agent information under a skill group and verify whether the removal aligns with your expectations.'."\n" + .'- If you accidentally remove an agent, you can invoke [UpdateAgent](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-updateagent) to update the agent data and reassign the skill group to the agent.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 50 times/second.'."\n" + .'- API-wide invocation frequency: 100 times/second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.', + 'changeSet' => [ + ['createdAt' => '2021-10-28T02:16:10.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAgentFromSkillGroup'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": 2,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>2</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'ramActions' => [], ], - 'GetInstanceList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RemoveSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'SkillGroupId', 'in' => 'formData', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'default' => '20', - ], + 'schema' => ['description' => 'Skill group ID. '."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** field in the response to obtain the skill group ID.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'TotalCount' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Message' => [ - 'type' => 'string', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageNumber' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'HttpStatusCode' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'CommodityInstances' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified parameter is invalid.', - 'errorCode' => 'InvalidParameter', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 400 => [ + ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Delete Skill Group', + 'summary' => 'Deletes a skill group in the Cloud Customer Service System based on the AICCS instance ID and skill group ID.', + 'description' => '- Deletion is a sensitive operation. Proceed with caution. '."\n" + .'- Before deletion, confirm the AICCS instance ID and the skill group ID to be deleted. Refer to the guidance in [Request Parameters](#api-detail-35) for details on how to obtain them. '."\n" + .'- After deletion, you can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API to verify the skill group status. '."\n" + .'- If you accidentally delete a skill group, you can recreate it by invoking the [CreateSkillGroup](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-createskillgroup) API.'."\n" + ."\n" + .'### Queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting. '."\n" + .'- API frequency: 1000 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetMcuLvsIp' => [ - 'summary' => '热线检测获取mcu ip地址', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ResetHotlineNumber' => [ + 'summary' => 'Invoke the ResetHotlineNumber API to reset the inbound (IVR flow) and outbound (effective scope) configuration information of a hotline number.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the console.', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'error message', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '{ "xmculvs":[ 0:{ "port":00 "ip":"0.0.0.0" "name":"lvs1" } ]}', - 'title' => 'result data', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'error code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', - ], - ], - 'title' => 'Schema of Response', - 'type' => 'object', - ], + [ + 'name' => 'HotlineNumber', + 'in' => 'formData', + 'schema' => ['description' => 'Hotline number.', 'example' => '0571********', 'pattern' => '^\\d+$', 'required' => true, 'title' => '', 'type' => 'string'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Data\\": \\"{ \\\\\\"xmculvs\\\\\\":[ 0:{ \\\\\\"port\\\\\\":00 \\\\\\"ip\\\\\\":\\\\\\"0.0.0.0\\\\\\" \\\\\\"name\\\\\\":\\\\\\"lvs1\\\\\\" } ]}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetMcuLvsIpResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>xxxx</Message>\\n <Data>{ \\"xmculvs\\":[ 0:{ \\"port\\":00 \\"ip\\":\\"0.0.0.0\\" \\"name\\":\\"lvs1\\" } ]}</Data>\\n</GetMcuLvsIpResponse>","errorExample":""}]', - 'title' => 'GetMcuLvsIp', - ], - 'GetOutbounNumList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Number description.', 'example' => '热线号码', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'BearerToken' => [], + 'name' => 'EnableInbound', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether the number is used for inbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'InboundFlowId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The IVR flow ID for inbound calls.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'InstanceId', + 'name' => 'EnableOutbound', + 'in' => 'formData', + 'schema' => ['description' => 'Whether used for outbound calls.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'OutboundAllDepart', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether outbound calls apply to all departments.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EnableInboundEvaluation', + 'in' => 'formData', + 'schema' => ['description' => 'Whether inbound call satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EnableOutboundEvaluation', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether outbound satisfaction evaluation is enabled.', 'example' => 'true', 'required' => true, 'title' => '', 'type' => 'boolean'], + ], + [ + 'name' => 'EvaluationLevel', 'in' => 'formData', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-****', - 'required' => true, - 'type' => 'string', + 'description' => 'Satisfaction level. Valid values:'."\n" + ."\n" + .'- **2**: Two-level (Satisfied, Not Satisfied)'."\n" + .'- **3**: Three-level (Satisfied, Neutral, Not Satisfied)'."\n" + .'- **4**: Four-level (Very Satisfied, Satisfied, Neutral, Not Satisfied)'."\n" + .'- **5**: Five-level (Very Satisfied, Satisfied, Neutral, Not Satisfied, Very Poor)', + 'example' => '2', + 'format' => 'int32', + 'required' => false, + 'title' => '', + 'type' => 'integer', + 'enum' => ['2', '3', '4', '5'], ], ], [ - 'name' => 'AccountName', + 'name' => 'OutboundRangeList', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@****.com', - 'required' => true, - 'type' => 'string', + 'description' => 'Outbound call effective scope.', + 'items' => [ + 'description' => 'Outbound call effective scope.', + 'properties' => [ + 'GroupIdList' => [ + 'description' => 'List of effective skill groups.'."\n" + ."\n" + .'> If the skill group list is empty, the setting applies to the entire department. Otherwise, it applies only to the specified skill groups under the department.'."\n", + 'items' => ['description' => 'Skill group ID.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', + ], + 'DepartmentId' => ['description' => 'Effective department ID.', 'example' => '123456', 'format' => 'int64', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + 'required' => false, + 'type' => 'object', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'Num' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'Value' => [ - 'description' => '', - 'example' => '07512234****', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - 'NumGroup' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Type' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => 'Jella', - 'type' => 'string', - ], - 'Value' => [ - 'description' => '', - 'example' => '7688****', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxx', 'title' => '', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'title' => '', 'type' => 'integer'], + 'Code' => ['description' => 'The status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'title' => '', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => '', 'type' => 'boolean'], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Reset Hotline Number', + 'changeSet' => [ + ['createdAt' => '2021-06-22T12:36:22.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetHotlineNumber'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Num\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"浙江省杭州市\\",\\n \\"Value\\": \\"07512234****\\"\\n }\\n ],\\n \\"NumGroup\\": [\\n {\\n \\"Type\\": 2,\\n \\"Description\\": \\"Jella\\",\\n \\"Value\\": \\"7688****\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetOutbounNumListResponse>\\n <Message>OK</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <NumGroup>\\n <Type>2</Type>\\n <Value>7688****</Value>\\n <Description>Jella</Description>\\n </NumGroup>\\n <Num>\\n <Type>1</Type>\\n <Value>07512234****</Value>\\n <Description>浙江省杭州市</Description>\\n </Num>\\n </Data>\\n <Code>Success</Code>\\n <Success>true</Success>\\n <HttpStatusCode>200</HttpStatusCode>\\n</GetOutbounNumListResponse>","errorExample":""}]', - 'title' => 'GetOutbounNumList', + 'ramActions' => [], ], - 'GetQualityProjectDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RestartOutboundTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'OutboundTaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '租户实例ID', - 'type' => 'string', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '15977801', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => true, - 'title' => '质检任务ID', - 'type' => 'integer', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'Message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'RequestId', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'title' => '质检任务状态', - 'type' => 'integer', - ], - 'ServicerList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:55555', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '坐席列表', - 'type' => 'array', - ], - 'ModifyTime' => [ - 'description' => '', - 'example' => '2021-04-07 18:07:19', - 'title' => '修改时间', - 'type' => 'string', - ], - 'QualityType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '质检类型', - 'type' => 'integer', - ], - 'DepList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '技能组分组', - 'type' => 'array', - ], - 'GroupList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '技能组列表', - 'type' => 'array', - ], - 'ProjectName' => [ - 'description' => '', - 'example' => '', - 'title' => '质检任务名称', - 'type' => 'string', - ], - 'Version' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => 'Version', - 'type' => 'integer', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '2021-04-07 18:07:18', - 'title' => '创建时间', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '15977801', - 'format' => 'int64', - 'title' => '质检任务ID', - 'type' => 'integer', - ], - 'QualityRuleIds' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '5369', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '质检规则ID', - 'type' => 'array', - ], - 'CheckFreqType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '质检周期', - 'type' => 'integer', - ], - ], - 'title' => 'Data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'Code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'Success', - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - 'type' => 'object', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<GetQualityProjectDetailResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <Status>0</Status>\\n <QualityType>1</QualityType>\\n <QualityRuleIds>5369</QualityRuleIds>\\n <CreateTime>2021-04-07 18:07:18</CreateTime>\\n <ProjectName>自动化质检任务</ProjectName>\\n <CheckFreqType>1</CheckFreqType>\\n <Version>1</Version>\\n <Id>15977801</Id>\\n <ModifyTime>2021-04-07 18:07:19</ModifyTime>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetQualityProjectDetailResponse>","errorExample":""}]', - 'title' => 'GetQualityProjectDetail', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'GetQualityProjectList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'RobotCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'Outbound caller number. View it in the Voice Service [Real Number Management](https://dyvmsnext.console.aliyun.com/number/list/normal) interface.', 'example' => '132****0849', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '15', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => false, - 'title' => '质检项ID', - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => 'Called number.', 'example' => '131****2204', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'RobotId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => false, - 'title' => '质检项名称', - 'type' => 'string', - ], + 'schema' => ['description' => 'Robot ID, which is the script ID. View the reviewed and approved script ID in the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface.', 'example' => '1000035******', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '0', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0', - 'format' => 'int32', - 'required' => false, - 'title' => '质检项状态', - 'type' => 'integer', - ], + 'schema' => ['description' => 'An ID reserved for the caller. This ID will be returned to the caller through the receipt message. It must be 1 to 15 bytes in length.', 'example' => '222356****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'RecordFlag', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '1', - 'format' => 'int32', - 'maximum' => '1000', - 'minimum' => '1', - 'required' => false, - 'title' => 'PageNo', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Whether to record the call. Valid values:'."\n" + ."\n" + .'- **false** (default): Do not record.'."\n" + .'- **true**: Record.'."\n", 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'EarlyMediaAsr', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '10', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', - 'required' => false, - 'title' => 'PageSize', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Whether to enable the number status detection identity. Valid values: '."\n" + ."\n" + .'- **false** (Default Value): Disable. '."\n" + .'- **true**: Enable. '."\n" + .'> When enabled, the reason for unanswered calls will be recorded. ', 'example' => 'false', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ - 'name' => 'checkFreqType', + 'name' => 'Params', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'required' => false, - 'title' => '质检频率', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Parameter list for the robot, in JSON format. The total length must not exceed 512 bytes. You can view the parameters in [Script Management](https://aiccs.console.aliyun.com/patter/list) > **Details** > **Input Parameters**, or by using the [ListRobotParams](~~2717999~~) API.', 'example' => '{'."\n" + .' "name": "张三",'."\n" + .' "age": "25"'."\n" + .'}', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'Returned data.', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'Message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'RequestId', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'properties' => [ - 'PageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'title' => 'PageSize', - 'type' => 'integer', - ], - 'QualityProjectList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'Status' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int32', - 'title' => '质检任务状态', - 'type' => 'integer', - ], - 'ServicerList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:555555', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '坐席列表', - 'type' => 'array', - ], - 'ModifyTime' => [ - 'description' => '', - 'example' => '2021-04-07 18:07:19', - 'title' => '修改时间', - 'type' => 'string', - ], - 'QualityType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '质检任务类型', - 'type' => 'integer', - ], - 'DepList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '技能组分组列表', - 'type' => 'array', - ], - 'GroupList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '0:123456', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '技能组列表', - 'type' => 'array', - ], - 'ProjectName' => [ - 'description' => '', - 'example' => '', - 'title' => '质检任务名称', - 'type' => 'string', - ], - 'Version' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '版本', - 'type' => 'integer', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '2021-04-07 18:07:18', - 'title' => 'CreateTime', - 'type' => 'string', - ], - 'Id' => [ - 'description' => '', - 'example' => '15977801', - 'format' => 'int64', - 'title' => '质检任务Id', - 'type' => 'integer', - ], - 'QualityRuleIds' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'example' => '5369', - 'format' => 'int64', - 'type' => 'integer', - ], - 'title' => '质检规则列表', - 'type' => 'array', - ], - 'CheckFreqType' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => '质检任务频率', - 'type' => 'integer', - ], - ], - 'type' => 'object', - ], - 'title' => '质检项列表', - 'type' => 'array', - ], - 'Total' => [ - 'description' => '', - 'example' => '35', - 'format' => 'int64', - 'title' => 'Total', - 'type' => 'integer', - ], - 'PageNo' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'title' => 'PageNo', - 'type' => 'integer', - ], - ], - 'title' => 'Data', - 'type' => 'object', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'Code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'Success', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'The unique receipt ID of this call, which is also the unique call ID.', 'example' => '1160128*****^10281427*****', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"QualityProjectList\\": [\\n {\\n \\"Status\\": 0,\\n \\"ServicerList\\": [\\n 0\\n ],\\n \\"ModifyTime\\": \\"2021-04-07 18:07:19\\",\\n \\"QualityType\\": 1,\\n \\"DepList\\": [\\n 0\\n ],\\n \\"GroupList\\": [\\n 0\\n ],\\n \\"ProjectName\\": \\"自动化质检任务\\",\\n \\"Version\\": 1,\\n \\"CreateTime\\": \\"2021-04-07 18:07:18\\",\\n \\"Id\\": 15977801,\\n \\"QualityRuleIds\\": [\\n 5369\\n ],\\n \\"CheckFreqType\\": 1\\n }\\n ],\\n \\"Total\\": 35,\\n \\"PageNo\\": 1\\n },\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetQualityProjectListResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>\\n <QualityProjectList>\\n <Status>0</Status>\\n <QualityType>1</QualityType>\\n <QualityRuleIds>5369</QualityRuleIds>\\n <CreateTime>2021-04-07 18:07:18</CreateTime>\\n <ProjectName>自动化质检任务</ProjectName>\\n <CheckFreqType>1</CheckFreqType>\\n <Version>1</Version>\\n <Id>15977801</Id>\\n <ModifyTime>2021-04-07 18:07:19</ModifyTime>\\n </QualityProjectList>\\n <PageNo>1</PageNo>\\n <PageSize>10</PageSize>\\n <Total>35</Total>\\n </Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</GetQualityProjectListResponse>","errorExample":""}]', - 'title' => 'GetQualityProjectList', + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"1160128*****^10281427*****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'Intelligent Contact Robot Outbound Call', + 'summary' => 'Initiate an outbound call using the Intelligent Contact Robot.'."\n", + 'description' => '- Before initiating an outbound call using the Intelligent Contact Robot, ensure that you already have a reviewed and approved script in the [Script Management](https://aiccs.console.aliyun.com/patter/list) interface and an approved real number in the Voice Service [Real Number Management](https://dyvmsnext.console.aliyun.com/number/list/normal) interface.'."\n" + ."\n" + .'- You can obtain the creation time of the call from the **date** parameter in the **Response Header** after invoking this API. '."\n" + .'> For example, if the **date** parameter is: `"date": "Mon, 24 Jun 2024 03:40:31 GMT"`, then the call creation time is: `"2024-06-24 03:40:31"`.'."\n" + ."\n" + .'### queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 1000 calls per second.'."\n" + ."\n" + .'> If the total calls from multiple users exceed the API frequency limit, throttle will be triggered.'."\n", + 'changeSet' => [ + ['createdAt' => '2021-05-19T13:35:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetQualityProjectLog' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SendCcoSmartCall' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'CalledShowNumber', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - ], + 'schema' => ['description' => 'Called party display number. This must be a purchased number.'."\n" + ."\n" + .'You can log on to the [Contact Center console](https://aiccs.console.aliyun.com/overview?spm=a2c4g.11186623.0.0.7f9bf9658X6jte) to view your purchased numbers.', 'example' => '0571****0000', 'required' => true, 'type' => 'string', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ActionTime' => [ - 'type' => 'string', - ], - 'ActionType' => [ - 'type' => 'string', - ], - 'ProjectCreateTime' => [ - 'type' => 'string', - ], - 'ProjectId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ActionData' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], - ], + [ + 'name' => 'CalledNumber', + 'in' => 'query', + 'schema' => ['description' => 'Callee number. Only numbers from the Chinese mainland are supported.', 'example' => '137****0000', 'required' => true, 'type' => 'string', 'title' => ''], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + [ + 'name' => 'VoiceCode', + 'in' => 'query', + 'schema' => ['description' => 'The audio playback file for Intelligent outbound calls, which supports both network files and TTS. Multiple files and TTS parameters can be mixed and separated by commas (,). The replacement values for TTS parameters are specified in **VoiceCodeParam**.'."\n" + ."\n" + .'- When using a network file for playback: Set the VoiceCode parameter to a publicly accessible URL of the audio file. We recommend using a .wav audio file with a sampling frequency of 8000 Hz or 16000 Hz.'."\n" + .'- When using TTS for playback: Set the VoiceCode parameter to a variable name such as $name$, and define the corresponding content for this variable in VoiceCodeParam.', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav,$name$', 'required' => true, 'type' => 'string', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, - ], - 'GetQualityResult' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'OutId', + 'in' => 'query', + 'schema' => ['description' => 'An ID reserved for the caller, which will ultimately be returned to the caller in the receipt message. '."\n" + .'It is of string type and must be 1 to 15 bytes in length. ', 'example' => '222356****', 'required' => false, 'type' => 'string', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'This parameter is not currently supported. ', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Volume', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'default' => '', - ], + 'schema' => ['description' => 'Playback volume for user audio. Valid values: –4 to 4. We recommend setting it to 1.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Speed', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'schema' => ['description' => 'This parameter is currently not supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'TouchStartTime', + 'name' => 'AsrModelId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ASR model ID. You can view the ASR model ID on the [ASR Model Management Page](https://aiccs.console.aliyun.com/sentence/model/private?spm=a2c4g.11186623.0.0.7f9b2964fYSGv4).', 'example' => 'bf71664d30d2478fb8cb8c39c6b6****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TouchEndTime', + 'name' => 'AsrBaseId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'ASR foundation model.'."\n" + ."\n" + .'- **customer_service_8k**: Mandarin.'."\n" + .'- **dialect_customer_service_8k**: Strong accent.'."\n" + .'- If only **asrModelId** is set, the specified ASR model is used.'."\n" + .'- If only **AsrBaseId** is set, the specified ASR foundation model is used.'."\n" + .'- If neither is set, the default ASR foundation model is used. By default, **AsrBaseId** is **customer_service_8k**, which corresponds to the Mandarin ASR foundation model.'."\n" + .'- If both are set, ensure they correctly correspond to each other.'."\n" + ."\n" + .'> When invoking the **SendCcoSmartCall** API, you must specify the ASR model to use. We recommend that you specify either **asrModelId** or **AsrBaseId**, but not both.', 'example' => 'customer_service_8k', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ChannelType', + 'name' => 'AsrAlsAmId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Acoustic model ID.', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'HitStatus', + 'name' => 'AsrVocabularyId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - ], + 'schema' => ['description' => 'Hotword ID. You can view the ASR hotword ID on the [ASR Hotword Management Page](https://aiccs.console.aliyun.com/sentence/vocab?spm=a2c4g.11186623.0.0.7f9bf965IKBpsi).', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'RecordFlag', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 1, - ], + 'schema' => ['description' => 'Whether to record during the call.'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], [ - 'name' => 'QualityRuleIds', + 'name' => 'PauseTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 1, - ], + 'schema' => ['description' => 'The pause duration. This parameter specifies how long a user must pause to indicate the end of a sentence. Unit: milliseconds. Valid values are **300–1200**. If the specified value is outside this range, PauseTime defaults to **800**.'."\n" + ."\n" + .'> The first setting takes effect; subsequent settings are ignored.', 'example' => '800', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'ProjectIds', + 'name' => 'MuteTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'required' => false, - 'maxItems' => 1, - ], + 'schema' => ['description' => 'Mute duration, used to set how long the user remains silent before the call ends. The unit is milliseconds, and the valid range is **1000–20000**. '."\n" + ."\n" + .'- If the specified value is outside this range, the default MuteTime is **10000**. '."\n" + .'- This parameter can be dynamically set during the call, and the last setting takes effect. ', 'example' => '10000', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'ActionCodeBreak', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether the initial playback file can be interrupted. The default value is **true**, meaning the initial playback file can be interrupted.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'DynamicId', + 'in' => 'query', + 'schema' => ['description' => 'A dynamic extension ID reserved for the caller. This ID is returned in the webhook address and used as a developer identity for the customer.', 'example' => '123456', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'EarlyMediaAsr', + 'in' => 'query', + 'schema' => ['description' => 'The early media speech recognition identity. When set to true, it records the reason why the call was not answered. The default value is **false**, meaning this feature is disabled.'."\n" + ."\n" + .'> To enable early media speech recognition, you must manually set this parameter to **true**.', 'example' => 'false', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'VoiceCodeParam', + 'in' => 'query', + 'schema' => ['description' => 'A JSON-formatted string for passing TTS parameters. It must correspond to the TTS parameters of VoiceCode.', 'example' => '{"name":"喂，你好"}', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The maximum call duration, in seconds. The call is automatically disconnected after timeout.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'ActionCodeTimeBreak', + 'in' => 'query', + 'schema' => ['description' => 'Interrupts based on the user\'s continuous speaking duration. Takes effect only when ActionCodeBreak is set to **true**. Unit: milliseconds.', 'example' => '120', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TtsConf', + 'in' => 'query', + 'schema' => ['description' => 'Whether to configure TTS voice parameters.'."\n" + .'- If set to **true**, you must configure the voice style using the TtsStyle, TtsVolume, and TtsSpeed parameters.'."\n" + .'- If set to **false**, related parameters do not take effect, even if configured.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + [ + 'name' => 'TtsStyle', + 'in' => 'query', + 'schema' => ['description' => 'The voice style for TTS variable playback. The default value is **xiaoyun**. For available styles, see the voice style list.', 'example' => 'xiaoyun', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'TtsVolume', + 'in' => 'query', + 'schema' => ['description' => 'Playback volume for TTS variables. Valid values: **0–100**. Default value: **0**.', 'example' => '10', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'TtsSpeed', + 'in' => 'query', + 'schema' => ['description' => 'The playback speed of the TTS variable. Valid values range from -200 to 200. The default value is 0.', 'example' => '100', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'BackgroundFileCode', + 'in' => 'query', + 'schema' => ['description' => 'ID of the background audio file played during the conversation between the user and the robot. You can log on to the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview), choose **Intelligent Interaction > Audio File Management**, and click **View Details** to obtain the corresponding audio ID.', 'example' => '2d4c-4e78-8d2a-afbb06cf****.wav', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'BackgroundVolume', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not currently supported. ', 'example' => '1', 'format' => 'int32', 'maximum' => '4', 'minimum' => '-4', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'BackgroundSpeed', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not currently supported.', 'example' => '1', 'format' => 'int32', 'required' => false, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'EnableITN', + 'in' => 'query', + 'schema' => ['description' => 'Whether to execute ITN in post-processing.'."\n" + ."\n" + .'> When set to **true**, Chinese numerals are converted to Arabic numerals in the output. The default value is **false**.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'default' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Returned data.', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'TotalNum' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'QualityResultResponseList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'type' => 'string', - ], - 'ProjectName' => [ - 'type' => 'string', - ], - 'TouchStartTime' => [ - 'type' => 'string', - ], - 'HitStatus' => [ - 'type' => 'boolean', - ], - 'RuleId' => [ - 'type' => 'string', - ], - 'ProjectId' => [ - 'type' => 'string', - ], - 'TouchId' => [ - 'type' => 'string', - ], - 'ChannelTypeName' => [ - 'type' => 'string', - ], - 'GroupId' => [ - 'type' => 'string', - ], - 'InstanceName' => [ - 'type' => 'string', - ], - 'ServicerName' => [ - 'type' => 'string', - ], - 'HitDetail' => [ - 'type' => 'string', - ], - 'MemberName' => [ - 'type' => 'string', - ], - 'ServicerId' => [ - 'type' => 'string', - ], - 'ChannelType' => [ - 'type' => 'string', - ], - 'RuleName' => [ - 'type' => 'string', - ], - ], - ], - ], - 'PageNo' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'ChannelTypeName' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Unique receipt ID for this call.', 'example' => '16012854210^10281427****', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of "OK" indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified parameter is invalid.', - 'errorCode' => 'InvalidParameter', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"16012854210^10281427****\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'Initiate Intelligent Outbound Call', + 'summary' => 'Initiate an Intelligent Speech Interaction call based on the callee\'s caller ID, callee number, and intelligent outbound call audio file.'."\n", + 'description' => '- The following characters cannot appear in the Intelligent Speech Interaction SendCcoSmartCall callback: `@ = : "" $ { } ^ * ￥`. '."\n" + .'- After invoking this API, the **Data** field in the response contains the unique receipt ID for this call, which can be used when invoking the [SendCcoSmartCallOperate](~~2718013~~) API.'."\n" + ."\n" + .'### Queries Per Second (QPS) Limits'."\n" + .'- Per-user invocation frequency: No rate limiting. '."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'requestParamsDescription' => '### Voice Style List'."\n" + ."\n" + .'- Xiaoyun Standard Female Voice: xiaoyun '."\n" + .'- Xiaogang Standard Male Voice: xiaogang '."\n" + .'- Ruoxi Gentle Female Voice: ruoxi '."\n" + .'- Xiaomeng Standard Female Voice: xiaomeng '."\n" + .'- Xiaowei Standard Male Voice: xiaowei '."\n" + .'- Amei Sweet Female Voice: amei '."\n" + .'- Xiaoxue Gentle Female Voice: xiaoxue '."\n" + .'- Siqi Gentle Female Voice: siqi '."\n" + .'- Sijia Standard Female Voice: sijia '."\n" + .'- Sicheng Standard Male Voice: sicheng '."\n" + .'- Siyue Gentle Female Voice: siyue '."\n" + .'- Xiaomei Sweet Female Voice: xiaomei '."\n" + .'- Sitong Standard Child Voice: sitong '."\n" + .'- Ning\'er Standard Female Voice: ninger '."\n" + .'- Xiaobei Loli Female Voice: xiaobei '."\n" + .'- Yina Zhejiang Mandarin Female Voice: yina '."\n", + 'changeSet' => [ + ['createdAt' => '2021-09-02T03:15:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetQualityRuleDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SendCcoSmartCallOperate' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ - 'name' => 'QualityRuleId', + 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'Unique receipt ID of the call. This can be obtained from the response of the [SendCcoSmartCall](~~311247~~) API.', 'example' => '116012854210^102814279****', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Command', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the action to be performed for the called number during an Intelligent Outbound Call. '."\n" + ."\n" + .'> Currently, only the **parallelBridge** parameter is supported, which indicates bridging the called number with a call center agent.', 'example' => 'parallelBridge', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => ['description' => 'Extension field.', 'example' => 'Param', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Returned data.', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'RuleCreateTime' => [ - 'type' => 'string', - ], - 'MatchType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RuleId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RuleTag' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'KeyWords' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'Name' => [ - 'type' => 'string', - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Result of the command execution. '."\n" + .'- **true**: The command executed successfully. '."\n" + .'- **false**: The command execution failed.', 'example' => 'true', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Request status code. A return value of OK indicates that the request succeeded.', 'example' => 'OK', 'type' => 'string', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'Initiate Intelligent Outbound Call', + 'summary' => 'Initiates a specified action during an Intelligent Outbound Call, applicable only to scenarios such as parallel transfer to a human agent or allowing a human agent to listen in on the man-machine dialogue.', + 'description' => '- This API can be successfully invoked only during an ongoing Intelligent Outbound Call. When invoking it, note that the **CallId** in the request parameters must be set to the unique receipt ID of the active call. '."\n" + .'- The **CallId** is the **Data** parameter returned when you invoke the [SendCcoSmartCall](~~2718012~~) API.', + 'changeSet' => [ + ['createdAt' => '2021-09-09T06:04:10.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => null, - ], - 'GetQualityRuleList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SendHotlineHeartBeat' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'BearerToken' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it in the <b>Instance Management</b> section of the left-side navigation pane in the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'minimum' => '1', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox specified during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - ], + 'name' => 'Token', + 'in' => 'formData', + 'schema' => ['description' => 'Heartbeat signature. '."\n" + ."\n" + .'You can obtain the token by invoking the [StartHotlineService](~~2718045~~) API.', 'docRequired' => true, 'example' => '0079e7a845e373****', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'result', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Total' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'PageNo' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'QualityRuleList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RuleCreateTime' => [ - 'type' => 'string', - ], - 'MatchType' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RuleId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'RuleTag' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'KeyWords' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - 'Name' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Send a hotline heartbeat request based on the instance ID, agent account name, and heartbeat signature.', + 'description' => '### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'GetQualityRuleTagList' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartAiCallTask' => [ + 'summary' => 'Starts a call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the call task.', 'type' => 'string', 'required' => true, 'example' => '1187**************', 'title' => ''], ], ], 'responses' => [ @@ -25618,59 +18655,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access is denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The status message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '58A32FFF-86EE-5CF0-B365-97E8C574C7F4', 'title' => ''], 'Data' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RuleTagName' => [ - 'type' => 'string', - ], - 'RuleTagId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ + 'description' => 'Indicates whether the task was successfully started. Valid values:'."\n" + ."\n" + .'- **true**: Success.'."\n" + ."\n" + .'- **false**: Failure.', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'type' => 'boolean', + 'example' => 'false', + 'title' => '', ], + 'Code' => ['description' => 'The status code. OK indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: Success.'."\n" + ."\n" + .'- **false**: Failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"58A32FFF-86EE-5CF0-B365-97E8C574C7F4\\",\\n \\"Data\\": false,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Start an outbound call job for the communication agent', + 'description' => '- Before you start a call task, ensure its status is Stopped.'."\n" + ."\n" + .'- If you do not have a call task, create one on the **Call Task Management** page or by calling the [CreateAiCallTask](~~2926796~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'HangUpDoubleCall' => [ - 'summary' => '移动端呼叫挂断', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartAiOutboundTask' => [ + 'summary' => 'Start an outbound calling job by instance ID and job ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25678,35 +18705,20 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => false, - 'title' => '实例ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_****', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Acid', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '68255155****', - 'required' => false, - 'title' => '会话ID', - 'type' => 'string', - ], + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and view the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and view the **TaskId** field in the response.', 'example' => '1763****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -25714,58 +18726,41 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'Id of the request', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => '错误信息', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => '错误码', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => '是否调用成功', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Start an outbound calling job', + 'description' => '- You can invoke this API to start an outbound calling job that is in the paused state. '."\n" + .'- An outbound calling job in the stopped state cannot be started again.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 20 times per second. '."\n" + .'- API invocation frequency: 20 times per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAiOutboundTask'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<HangUpDoubleCallResponse>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n <Code>200</Code>\\n <Message>xxxx</Message>\\n</HangUpDoubleCallResponse>","errorExample":""}]', - 'title' => 'HangUpDoubleCall', + 'ramActions' => [], ], - 'HangupThirdCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartCall' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25776,78 +18771,33 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using a UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'JobId', + 'name' => 'Caller', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Caller number for the hotline outbound call.', 'docRequired' => true, 'example' => '906****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ConnectionId', + 'name' => 'Callee', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Callee number for the hotline outbound call.', 'docRequired' => true, 'example' => '1360987****', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -25855,60 +18805,43 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Agent-initiated outbound call', + 'summary' => 'Initiate an outbound call based on the instance ID, agent account name, hotline outbound caller number, and callee number.', + 'description' => '### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'HoldCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartCallV2' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25919,78 +18852,49 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique customer request ID. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent account name (agent logon name).', 'docRequired' => true, 'example' => '123@123.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CallId', + 'name' => 'Caller', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Caller number for hotline outbound calls.', 'docRequired' => true, 'example' => '9065****', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'CallerType', 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'Call type. Valid values:'."\n" + ."\n" + .'- **1**: Inbound'."\n" + .'- **2**: Outbound', 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', + 'example' => '1', + 'format' => 'int32', + 'required' => true, + 'type' => 'integer', + 'enum' => ['1', '2'], + 'title' => '', ], ], [ - 'name' => 'ConnectionId', + 'name' => 'Callee', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Callee number for hotline outbound calls.', 'docRequired' => true, 'example' => '136****1111', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -25998,152 +18902,94 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of Success indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Agent-initiated outbound call', + 'summary' => 'Invoke StartCallV2 to initiate an outbound call V2.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'ramActions' => [], ], - 'InsertTaskDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartChatWork' => [ + 'summary' => 'Invoke StartChatWork to switch an online agent to the working status.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OutboundTaskId', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], - ], - [ - 'name' => 'CallInfos', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. You can obtain it from the Artificial Intelligence Cloud Call Service console.', 'example' => 'ccc_xp_pre***', 'required' => true, 'title' => 'instanceId', 'type' => 'string'], ], [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent logon name.', 'example' => '123@123.com', 'required' => true, 'title' => 'accountName', 'type' => 'string'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'title' => 'message', 'type' => 'string'], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'requestId', 'type' => 'string'], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int32', 'title' => 'httpStatusCode', 'type' => 'integer'], + 'Data' => ['description' => 'A value of **1** indicates that the user has switched to the working status.', 'example' => '1', 'title' => 'data', 'type' => 'string'], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'title' => 'code', 'type' => 'string'], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'title' => 'success', 'type' => 'boolean'], ], + 'title' => 'result', + 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['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.', 'errorCode' => 'IdempotentParameterMismatch', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Switch an online agent to the working status', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartChatWork'], + ], ], - 'responseDemo' => null, + 'ramActions' => [], ], - 'JoinThirdCall' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26154,89 +19000,23 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation and can be generated using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'title' => '', 'type' => 'string'], ], [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'ConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', - 'required' => false, - 'type' => 'string', - ], - ], - [ - 'name' => 'HoldConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -26244,148 +19024,98 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Token required to initiate a heartbeat, returned after a successful request.', 'example' => '0079e7a845e373****', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'The specified agent does not exist.', - 'errorCode' => 'NoAgentFound', - ], - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"0079e7a845e373****\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Start Hotline Service', + 'summary' => 'Sign in a hotline agent by instance ID and agent account name to start the hotline service. ', + 'description' => '- The **Data** parameter returned by this API is the token required to initiate a heartbeat. '."\n" + .'- If the agent takes a break, you can pause the hotline service by invoking the [SuspendHotlineService](~~2718046~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-05-12T03:54:58.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'ListChatRecordDetail' => [ - 'summary' => '根据时间段查询在线会话详情，包含会话内容，时间段范围最长不超过1天', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartMicroOutbound' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ProdCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'clientToken', - 'type' => 'string', - ], + 'schema' => ['description' => 'Product name. Default value: **aiccs**.', 'example' => 'aiccs', 'required' => false, 'type' => 'string', 'default' => 'aiccs', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'AccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'Account type.', 'example' => 'BUC_TYPE', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CloseTimeEnd', + 'name' => 'AccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1614582000000', - 'format' => 'int64', - 'required' => false, - 'title' => '在线挂断的时间范围', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Account ID.', 'example' => '223457****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'CommandCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'minimum' => '1', - 'required' => false, - 'title' => '当前页', - 'type' => 'integer', - 'default' => '1', - ], + 'schema' => ['description' => 'Instruction code.', 'example' => 'outBound_Call', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'CallingNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'required' => false, - 'title' => '每页数据量', - 'type' => 'integer', - 'default' => '500', - ], + 'schema' => ['description' => 'Calling number.', 'example' => '1367123****', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CloseTimeStart', + 'name' => 'CalledNumber', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1614578400000', - 'format' => 'int64', - 'required' => false, - 'title' => '在线挂断的时间范围', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Called number.', 'example' => '0571456****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ExtInfo', + 'in' => 'query', + 'schema' => ['description' => 'Business information.', 'example' => '{"caseId":23232****}', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'Custom AppName for the business.', 'example' => 'aliyun', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -26393,251 +19123,59 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'ResultData' => [ - 'description' => '', - 'properties' => [ - 'OnePageSize' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalPage' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'ServicerName' => [ - 'description' => '', - 'example' => '123@123.com', - 'type' => 'string', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '1614578410000', - 'format' => 'int64', - 'title' => '在线结束时间', - 'type' => 'integer', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '1614578400000', - 'format' => 'int64', - 'title' => '在线开始时间', - 'type' => 'integer', - ], - 'MessageList' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'SenderName' => [ - 'description' => '', - 'example' => 'account1', - 'type' => 'string', - ], - 'Content' => [ - 'description' => '', - 'example' => '', - 'type' => 'string', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '1614578400000', - 'format' => 'int64', - 'type' => 'integer', - ], - 'SenderType' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int64', - 'type' => 'integer', - ], - 'MsgType' => [ - 'description' => '', - 'example' => 'MSG', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'title' => '在线会话详细信息', - 'type' => 'array', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', - ], + 'InvokeCreateTime' => ['description' => 'Creation Time', 'example' => '2019-05-23 17:30:32.525', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'InvokeCmdId' => ['description' => 'Command ID.', 'example' => '8883f165-4a0d-4da2-a2d2', 'type' => 'string', 'title' => ''], + 'CustomerInfo' => ['description' => 'Customer information.', 'example' => '{\\"caseId\\":2323****}', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], ], - 'title' => 'result', 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', - ], + ['errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', 'errorCode' => 'Permission.NotAuthorized', 'description' => ''], + ['errorMessage' => 'Parameter error.', 'errorCode' => 'Parameter.Error', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"InvokeCreateTime\\": \\"2019-05-23 17:30:32.525\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"InvokeCmdId\\": \\"8883f165-4a0d-4da2-a2d2\\",\\n \\"CustomerInfo\\": \\"{\\\\\\\\\\\\\\"caseId\\\\\\\\\\\\\\":2323****}\\",\\n \\"Code\\": \\"200\\"\\n}","type":"json"}]', + 'title' => 'Initiate a Call', + 'summary' => 'Invoke the StartMicroOutbound API to initiate an outbound call request.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 10,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 100,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"MessageList\\": [\\n {\\n \\"SenderName\\": \\"account1\\",\\n \\"Content\\": \\"你好\\",\\n \\"CreateTime\\": 1614578400000,\\n \\"SenderType\\": 2,\\n \\"MsgType\\": \\"MSG\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListChatRecordDetailResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ResultData>\\n <CurrentPage>1</CurrentPage>\\n <TotalResults>100</TotalResults>\\n <TotalPage>10</TotalPage>\\n <OnePageSize>10</OnePageSize>\\n <Data>\\n <ServicerName>123@123.com</ServicerName>\\n <StartTime>1614578400000</StartTime>\\n <EndTime>1614578410000</EndTime>\\n <MessageList>\\n <SenderName>account1</SenderName>\\n <Content>你好</Content>\\n <SenderType>2</SenderType>\\n <CreateTime>1614578400000</CreateTime>\\n <MsgType>MSG</MsgType>\\n </MessageList>\\n </Data>\\n </ResultData>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListChatRecordDetailResponse>","errorExample":""}]', - 'title' => ' ListChatRecordDetail', + 'ramActions' => [], ], - 'ListHotlineRecordDetail' => [ - 'summary' => '根据时间段查询热线详情列表，包含热线通话信息，时间段范围最长不超过1天', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartTask' => [ + 'summary' => 'Start a successfully created Intelligent Contact Robot calling job.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'clientToken', - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => '实例id', - 'type' => 'string', - ], - ], - [ - 'name' => 'CloseTimeEnd', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1614582000000', - 'format' => 'int64', - 'required' => false, - 'title' => '热线挂断的时间范围', - 'type' => 'integer', - ], - ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'minimum' => '1', - 'required' => false, - 'title' => '当前页', - 'type' => 'integer', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int32', - 'required' => false, - 'title' => '每页数据量', - 'type' => 'integer', - 'default' => '100', - ], + 'schema' => ['description' => 'The unique job ID of the robot calling task. You can view it on the [Task Management](https://aiccs.console.aliyun.com/job/list) page or obtain it by using the [CreateTask](~~223556~~) API.'."\n", 'example' => '12****', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'CloseTimeStart', + 'name' => 'StartNow', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1614578400000', - 'format' => 'int64', - 'required' => false, - 'title' => '热线挂断的时间范围', - 'type' => 'integer', - ], + 'schema' => ['description' => 'Indicates whether to start immediately. Valid values:'."\n" + .'- **true**: Yes.'."\n" + .'- **false**: No, which means the job will not be started.'."\n", 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], ], ], 'responses' => [ @@ -26645,291 +19183,127 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'ResultData' => [ - 'description' => '', - 'properties' => [ - 'OnePageSize' => [ - 'description' => '', - 'example' => '100', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalPage' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int64', - 'type' => 'integer', - ], - 'CurrentPage' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'type' => 'integer', - ], - 'TotalResults' => [ - 'description' => '', - 'example' => '945', - 'format' => 'int64', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'ServicerName' => [ - 'description' => '', - 'example' => '123@123.com', - 'type' => 'string', - ], - 'EndTime' => [ - 'description' => '', - 'example' => '1614578410000', - 'format' => 'int64', - 'title' => '热线结束时间', - 'type' => 'integer', - ], - 'StartTime' => [ - 'description' => '', - 'example' => '1614578400000', - 'format' => 'int64', - 'title' => '热线开始时间', - 'type' => 'integer', - ], - 'OssUrl' => [ - 'description' => '', - 'example' => 'http://xxx.xxxxx/xx.wav', - 'title' => '热线通话录音地址', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'type' => 'array', - ], - ], - 'title' => 'data', - 'type' => 'object', - ], - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'Request ID.'."\n", 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'Request status code. A value of OK indicates that the request succeeded.'."\n", 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'result', + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', - ], + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResultData\\": {\\n \\"OnePageSize\\": 100,\\n \\"TotalPage\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"TotalResults\\": 945,\\n \\"Data\\": [\\n {\\n \\"ServicerName\\": \\"123@123.com\\",\\n \\"EndTime\\": 1614578410000,\\n \\"StartTime\\": 1614578400000,\\n \\"OssUrl\\": \\"http://xxx.xxxxx/xx.wav\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListHotlineRecordDetailResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <ResultData>\\n <CurrentPage>1</CurrentPage>\\n <TotalResults>945</TotalResults>\\n <TotalPage>10</TotalPage>\\n <OnePageSize>100</OnePageSize>\\n <Data>\\n <ServicerName>123@123.com</ServicerName>\\n <StartTime>1614578400000</StartTime>\\n <EndTime>1614578410000</EndTime>\\n <OssUrl>http://xxx.xxxxx/xx.wav</OssUrl>\\n </Data>\\n </ResultData>\\n <Code>200</Code>\\n <Success>true</Success>\\n</ListHotlineRecordDetailResponse>","errorExample":""}]', - 'title' => 'ListHotlineRecordDetail', - ], - 'ListRoles' => [ - 'summary' => '获取租户下的所有角色', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Start Job'."\n", + 'description' => '- You can invoke this API to start a successfully created Intelligent Contact Robot calling job, or manually start the job on the [Task Management](https://aiccs.console.aliyun.com/job/list) page.'."\n" + ."\n" + .'- Before invoking this API, ensure that you already have a successfully created Intelligent Contact Robot calling job.'."\n" + ."\n" + .'- If you do not have a successfully created Intelligent Contact Robot outbound calling job, you can click to create a job on the [Task Management](https://aiccs.console.aliyun.com/job/list) page or create one by using the [CreateTask](~~2718003~~) API.'."\n" + ."\n" + .'### queries per second (QPS) Limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:StartTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'StopAiCallTask' => [ + 'summary' => 'Stops an outbound call task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'title' => 'clientToken', - 'type' => 'string', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'title' => '租户实例id', - 'type' => 'string', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '1187**************', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7124F972-BAB8-5D1E-90FC-01CB10713B29', 'title' => ''], 'Data' => [ - 'description' => '', - 'items' => [ - 'description' => '', - 'properties' => [ - 'RoleGroupId' => [ - 'description' => '', - 'example' => '0', - 'format' => 'int64', - 'title' => '所属角色组id', - 'type' => 'integer', - ], - 'BuId' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '租户id', - 'type' => 'integer', - ], - 'Description' => [ - 'description' => '', - 'example' => 'Admin', - 'title' => '角色描述', - 'type' => 'string', - ], - 'CreateTime' => [ - 'description' => '', - 'example' => '2020-01-03T20:25:33Z', - 'title' => '创建时间', - 'type' => 'string', - ], - 'Title' => [ - 'description' => '', - 'example' => '', - 'title' => '角色名称', - 'type' => 'string', - ], - 'RoleGroupName' => [ - 'description' => '', - 'example' => '', - 'title' => '所属角色组名称', - 'type' => 'string', - ], - 'RoleId' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int64', - 'title' => '角色id', - 'type' => 'integer', - ], - 'Code' => [ - 'description' => '', - 'example' => 'admin', - 'title' => '角色code', - 'type' => 'string', - ], - ], - 'type' => 'object', - ], - 'title' => 'data', - 'type' => 'array', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', + 'description' => 'Indicates whether the task was stopped successfully. Valid values:'."\n" + ."\n" + .'- **true**: The operation was successful.'."\n" + ."\n" + .'- **false**: The operation failed.', + 'enumValueTitles' => ['true' => '', 'false' => ''], 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], + 'Code' => ['description' => 'The request status code. A value of `OK` indicates that the request was successful.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The call was successful.'."\n" + ."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'title' => 'result', - 'type' => 'object', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"RoleGroupId\\": 0,\\n \\"BuId\\": 1,\\n \\"Description\\": \\"Admin\\",\\n \\"CreateTime\\": \\"2020-01-03T20:25:33Z\\",\\n \\"Title\\": \\"企业管理员\\",\\n \\"RoleGroupName\\": \\"角色组名称\\",\\n \\"RoleId\\": 1,\\n \\"Code\\": \\"admin\\"\\n }\\n ],\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListRolesResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>\\n <RoleId>1</RoleId>\\n <CreateTime>2020-01-03T20:25:33Z</CreateTime>\\n <BuId>1</BuId>\\n <Title>企业管理员</Title>\\n <Code>admin</Code>\\n <Description>Admin</Description>\\n <RoleGroupId>0</RoleGroupId>\\n <RoleGroupName>角色组名称</RoleGroupName>\\n </Data>\\n <Success>true</Success>\\n</ListRolesResponse>","errorExample":""}]', - 'title' => 'ListRoles', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"7124F972-BAB8-5D1E-90FC-01CB10713B29\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Stop the Intelligent Agent outbound calling job', + 'description' => '- Before you stop an outbound call task, ensure that the task has been created and its status is `running`.'."\n" + ."\n" + .'- If you have not created an outbound call task, create one on the Outbound Task Management page or call the [CreateAiCallTask](~~2926796~~) operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'MakeCall' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopAiOutboundTask' => [ + 'summary' => 'Pause an outbound calling job by instance ID and job ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26937,78 +19311,21 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OuterAccountId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'OuterAccountType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ALIPAY', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'CommandCode', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'outBound_Call', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'CallingNumber', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0571456****', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'CalledNumber', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '130****0000', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'ExtInfo', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '{"bizId": 23323}', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123456', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -27016,94 +19333,54 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Pause an outbound calling job', + 'description' => 'After pausing an outbound calling job, you can invoke the [StartAiOutboundTask](~~2718027~~) API to restart it.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 20 times/second.'."\n" + .'- API invocation frequency: 20 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAiOutboundTask'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<MakeCallResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>true</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</MakeCallResponse>","errorExample":""}]', - 'title' => 'MakeCall', + 'ramActions' => [], ], - 'QueryHotlineInQueue' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StopTask' => [ + 'summary' => 'Pause an Intelligent Contact Robot calling job that has been successfully started.'."\n", + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OuterGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], - ], - [ - 'name' => 'OuterGroupType', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'mybank', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The unique job ID of the robot calling task. You can view it on the [Task Management](https://aiccs.console.aliyun.com/job/list) page or obtain it by using the [CreateTask](~~223556~~) API. ', 'example' => '12****', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], ], 'responses' => [ @@ -27111,212 +19388,232 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '{"n_online_now":10,"n_idle_now":3,"n_resttype_now":3,"n_acw_now":1}', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID. ', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'The request status code. A value of OK indicates that the request succeeded. ', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + 400 => [ + ['errorMessage' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'errorCode' => 'PermissionInsufficient', 'description' => ''], + ['errorMessage' => 'The parameter is invalid.', 'errorCode' => 'ParameterError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Pause Job '."\n", + 'description' => '- You can use this API to pause an Intelligent Contact Robot calling job that has been successfully started, or manually pause the job on the [Task Management](https://aiccs.console.aliyun.com/job/list) interface.'."\n" + ."\n" + .'- Before invoking this API, ensure that you already have a successfully started Intelligent Contact Robot calling job.'."\n" + ."\n" + .'- If you do not have a successfully started Intelligent Contact Robot calling job, click **Start** on the [Task Management](https://aiccs.console.aliyun.com/job/list) interface or start a job by using the [StartTask](~~2718005~~) API.'."\n" + ."\n\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 500 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{\\\\\\"n_online_now\\\\\\":10,\\\\\\"n_idle_now\\\\\\":3,\\\\\\"n_resttype_now\\\\\\":3,\\\\\\"n_acw_now\\\\\\":1}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryHotlineInQueueResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>{\\"n_online_now\\":10,\\"n_idle_now\\":3,\\"n_resttype_now\\":3,\\"n_acw_now\\":1}</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</QueryHotlineInQueueResponse>","errorExample":""}]', - 'title' => 'QueryHotlineInQueue', - ], - 'QueryOutboundTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:StopTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'SubmitAudioNote' => [ + 'summary' => 'Submits a recording notes task.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsACHORA'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - 'default' => '', - ], + 'schema' => ['description' => 'The ID of the notes agent. Specify the ID of a published recording notes agent.', 'type' => 'string', 'required' => true, 'example' => '200', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'FilePath', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The storage path of the recording file in OSS. Use the FilePath returned by the upload address retrieval operation.', 'type' => 'string', 'required' => true, 'example' => 'audio-note/100/uuid/test.wav', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'BizId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The custom task ID defined by the business side. This ID is used to associate external business records during callbacks or troubleshooting.', 'type' => 'string', 'required' => false, 'example' => 'biz-001', 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'LlmModelId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the LLM model used for notes inference. If this parameter is not specified, the default model configuration of the agent is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '88', 'title' => ''], ], - [ - 'name' => 'EndDate', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access is denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '12345678-1234-1234-1234-123456789012', 'title' => ''], + 'Data' => ['description' => 'The recording notes task ID returned after successful submission. This value corresponds to the CallId in the subsequent asynchronous notes result callback.', 'type' => 'string', 'example' => '100000000000000001_100000000000000002', 'title' => ''], + 'Code' => ['description' => 'The request status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit offline voice notes', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"12345678-1234-1234-1234-123456789012\\",\\n \\"Data\\": \\"100000000000000001_100000000000000002\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SuspendHotlineService' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'BearerToken' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'SkillGroup', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Ani', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'Agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'Reason for the short break. Valid values:'."\n" + .'- **1**: Short break (default value).'."\n" + .'- **2**: Meal break.'."\n" + .'- **3**: Meeting.'."\n" + .'- **4**: Coaching.'."\n" + .'- **5**: Training.', 'example' => '1', 'format' => 'int32', 'maximum' => '5', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '1', 'title' => ''], ], - [ - 'name' => 'DepartmentId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates that the request succeeded.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.'."\n", 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Pause hotline service when an agent takes a short break.', + 'description' => 'If the break ends and you need to resume hotline service, you can invoke the [StartHotlineService](~~2718045~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 100 queries per second (QPS).'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'SuspendOutboundTask' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'InstanceId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'OutboundTaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'default' => '20', - ], + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775700', 'minimum' => '0', 'description' => '', 'title' => '', 'example' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['type' => 'string', 'required' => true, 'docRequired' => true, 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -27324,291 +19621,135 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'type' => 'string', - ], - 'CurrentPage' => [ - 'type' => 'string', - ], - 'TotalResults' => [ - 'type' => 'string', - ], - 'List' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'GroupName' => [ - 'type' => 'string', - ], - 'SkillGroup' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Description' => [ - 'type' => 'string', - ], - 'EndTime' => [ - 'type' => 'string', - ], - 'GmtModified' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'StartTime' => [ - 'type' => 'string', - ], - 'Creator' => [ - 'type' => 'string', - ], - 'EndDate' => [ - 'type' => 'string', - ], - 'Name' => [ - 'type' => 'string', - ], - 'StartDate' => [ - 'type' => 'string', - ], - 'CallerNum' => [ - 'type' => 'string', - ], - 'BuId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Type' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'GmtCreate' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Model' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ExtAttrs' => [ - 'type' => 'string', - ], - 'RetryInterval' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'RetryTime' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'DepartmentId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Modifier' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Success' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"\\",\\n \\"RequestId\\": \\"\\",\\n \\"Data\\": \\"\\",\\n \\"Code\\": \\"\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => '', + 'summary' => '', ], - 'QueryTaskDetail' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TerminateAiOutboundTask' => [ + 'summary' => 'Terminate an outbound call job by instance ID and job ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OutboundTaskId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'StatusList', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'EndReasonList', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'SkillGroup', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'ServicerName', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'ServicerId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'PriorityList', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + ."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'agent_****', 'required' => true, 'title' => '', 'type' => 'string'], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'schema' => ['description' => 'Job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '1763****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], - [ - 'name' => 'Ani', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], - ], - [ - 'name' => 'Dnis', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'type' => 'string', - 'required' => false, + 'description' => 'Schema of Response', + 'properties' => [ + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'title' => 'Schema of Response', + 'type' => 'object', + 'example' => '', ], ], - [ - 'name' => 'Sid', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Terminate Outbound Call Job', + 'description' => '- This API supports terminating an outbound call job. Once terminated, the job cannot be restarted.'."\n" + .'- To temporarily stop an outbound call job, you can invoke the [StopAiOutboundTask](~~2718024~~) API.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 20 times/second.'."\n" + .'- API-wide invocation frequency: 20 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API frequency limit, throttling will be triggered.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateAiOutboundTask'], ], + ], + 'ramActions' => [], + ], + 'TestLargeModel' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DepartmentIdList', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '254669', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], + ], + 'parameters' => [ [ - 'name' => 'InstanceId', + 'name' => 'ModelCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The ID of the test scenario.', 'type' => 'string', 'required' => false, 'example' => '1232', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'UserDialogContent', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The user dialog content.', 'type' => 'string', 'required' => false, 'example' => '你好。', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'BaseModel', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The base models.', + 'type' => 'array', + 'items' => ['description' => 'The code of the base model.', 'type' => 'string', 'required' => false, 'example' => '[\\"qwen-flash\\"]', 'title' => ''], 'required' => false, - 'maximum' => '10000', - 'minimum' => '0', - 'default' => '1', + 'example' => '', + 'title' => '', ], ], ], @@ -27617,139 +19758,52 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'type' => 'string', - ], + 'AccessDeniedDetail' => ['description' => 'Details about the authentication error.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'F2051E18-FF3F-5C08-8D24-6F150D2AF757'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], 'Data' => [ - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'type' => 'string', - ], - 'CurrentPage' => [ - 'type' => 'string', - ], - 'TotalResults' => [ - 'type' => 'string', - ], - 'List' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'OutboundTaskId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'SkillGroup' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'OutboundNum' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Priority' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'GmtModified' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'BuId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'MemberId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'GmtCreate' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'ServicerName' => [ - 'type' => 'string', - ], - 'EndReason' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'Dnis' => [ - 'type' => 'string', - ], - 'ExtAttrs' => [ - 'type' => 'string', - ], - 'MemberName' => [ - 'type' => 'string', - ], - 'RetryTime' => [ - 'type' => 'string', - ], - 'DepartmentId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Id' => [ - 'type' => 'integer', - 'format' => 'int32', - ], - 'ServicerId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Ani' => [ - 'type' => 'string', - ], - ], - ], + 'title' => '', + 'description' => 'The list of data entries.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The output text generated by the model.', 'type' => 'string', 'example' => '⌈您好！我是阿里云官网的 AI 小助手。\\n\\n您输入的“得到的”似乎不是一个完整的问题。请问您具体想了解关于阿里云的哪些知识？\\n\\n例如：\\n* 阿里云有哪些核心产品（如 ECS、RDS、OSS 等）？\\n* 如何购买或续费云服务器？\\n* 阿里云的安全防护能力有哪些？\\n* 如何获取技术支持或查看文档？\\n\\n请随时提出您的具体问题，我将为您解答！⌋', 'title' => ''], + 'ErrorMsg' => ['description' => 'The error message if the model fails to process the request.', 'type' => 'string', 'example' => '{\\"code\\":\\"InvalidApiKey\\",\\"message\\":\\"Invalid API-key provided.\\",\\"request_id\\":\\"dd14065e-3dd5-90a1-b8ee-d6c80891defe\\"}', 'title' => ''], + 'ModelVersion' => ['description' => 'The version of the model that processed the request.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the model processing was successful.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => 'A data object within the Data list.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'string', - ], + 'Code' => ['description' => 'The status code. A value of `OK` indicates that the call was successful.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], ], + 'description' => 'The returned data.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'TestLargeModel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => null, + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"F2051E18-FF3F-5C08-8D24-6F150D2AF757\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Output\\": \\"⌈您好！我是阿里云官网的 AI 小助手。\\\\\\\\n\\\\\\\\n您输入的“得到的”似乎不是一个完整的问题。请问您具体想了解关于阿里云的哪些知识？\\\\\\\\n\\\\\\\\n例如：\\\\\\\\n* 阿里云有哪些核心产品（如 ECS、RDS、OSS 等）？\\\\\\\\n* 如何购买或续费云服务器？\\\\\\\\n* 阿里云的安全防护能力有哪些？\\\\\\\\n* 如何获取技术支持或查看文档？\\\\\\\\n\\\\\\\\n请随时提出您的具体问题，我将为您解答！⌋\\",\\n \\"ErrorMsg\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"InvalidApiKey\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Invalid API-key provided.\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"request_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"dd14065e-3dd5-90a1-b8ee-d6c80891defe\\\\\\\\\\\\\\"}\\",\\n \\"ModelVersion\\": \\"1\\",\\n \\"Success\\": false\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'summary' => '', ], - 'QueryTickets' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'TransferCallToSkillGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -27758,468 +19812,562 @@ 'BearerToken' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'Artificial Intelligence Cloud Call Service (AICCS) instance ID.'."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CaseId', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '223468****', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'CaseType', + 'name' => 'SkillGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1223', - 'format' => 'int32', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Skill group ID.', 'docRequired' => true, 'example' => '356543', 'format' => 'int64', 'required' => true, 'type' => 'integer', 'title' => ''], ], [ - 'name' => 'CaseStatus', + 'name' => 'CallId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'format' => 'int32', - 'maximum' => '9223372036854775807', - 'minimum' => '-100000', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Hotline session ID.', 'docRequired' => true, 'example' => '7719786', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'SrType', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '29506', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The jobId in the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719787', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'TaskStatus', + 'name' => 'ConnectionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '3', - 'format' => 'int32', - 'maximum' => '9223372036854775807', - 'minimum' => '-10000000', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'The connId in the WebSocket after an inbound call.', 'docRequired' => true, 'example' => '7719788', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ChannelId', + 'name' => 'HoldConnectionId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '02acfefd3fa14049826ac1a89e1xxxxx', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The holdConnId in the WebSocket after an inbound call (required only for two-step transfer).', 'docRequired' => true, 'example' => '0', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'ChannelType', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '9223372036854775807', - 'minimum' => '-10000000', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Default value: **1**. Valid values:'."\n" + .'- **1**: Single-step transfer.'."\n" + .'- **2**: Two-step transfer.', 'example' => '1', 'format' => 'int32', 'maximum' => '2', 'minimum' => '1', 'required' => false, 'type' => 'integer', 'default' => '1', 'title' => ''], ], [ - 'name' => 'TouchId', + 'name' => 'IsSingleTransfer', 'in' => 'formData', + 'schema' => ['description' => 'Default value: **true**. Valid values:'."\n" + .'- **true**: Single-step transfer.'."\n" + .'- **false**: Two-step transfer.', 'example' => 'true', 'required' => false, 'type' => 'boolean', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'example' => '15030609', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'required' => false, - 'type' => 'integer', + 'description' => 'result', + 'properties' => [ + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Error encoding.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + ], + 'type' => 'object', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 500 => [ + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Execute a Single-Step or Two-Step Transfer to a Skill Group', + 'summary' => 'Invoke the TransferCallToSkillGroup API to execute a single-step or two-step transfer to a skill group.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateAgent' => [ + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DealId', + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], + 'parameters' => [ + [ + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'format' => 'int64', - 'maximum' => '9223372036854775807', - 'minimum' => '-1', - 'required' => false, - 'type' => 'integer', - ], + 'schema' => ['description' => 'Unique ID for the customer request. Used for idempotency validation. You can generate it using UUID.', 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'Extra', + 'name' => 'InstanceId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'object', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The agent account name, which is the phone number or mailbox entered during account registration. It is unique within the instance. '."\n" + .'> Update is not supported.', 'docRequired' => true, 'example' => 'username@example.com', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'DisplayName', 'in' => 'formData', + 'schema' => ['description' => 'Agent\'s display name.', 'docRequired' => true, 'example' => 'XX测试', 'required' => true, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'SkillGroupId', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '10', - 'format' => 'int32', - 'maximum' => '100', - 'minimum' => '1', + 'description' => 'Skill groups to which the agent belongs.', + 'items' => ['description' => 'Skill group.', 'example' => '2345****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'integer', - 'default' => '10', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CurrentPage', + 'name' => 'SkillGroupIdList', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '5000', - 'minimum' => '0', + 'description' => 'List of skill groups to which the agent belongs.', + 'items' => ['description' => 'List of skill groups. Separate multiple skill groups with commas (,).', 'example' => '2321****,4567****', 'format' => 'int64', 'required' => false, 'type' => 'integer', 'title' => ''], + 'maxItems' => 200, 'required' => false, - 'type' => 'integer', - 'default' => '0', + 'type' => 'array', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '{ "totalResults":1 "previousPage":1 "data":[ 0:{ "serviceType":1 "lastUrgeTime":0 "queueId":0 "sopCateId":252011 "totalUrgeMemo":"" "taskGmtModified":0 "departmentId":10 "groupId":0 "channelType":1 "questionInfo":"" "templateId":0 "deadLine":0 "srType":30701 "caseId":2000000001165962}', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'OK', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of "Success" indicates a successful call.', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values:'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"{ \\\\\\"totalResults\\\\\\":1 \\\\\\"previousPage\\\\\\":1 \\\\\\"data\\\\\\":[ 0:{ \\\\\\"serviceType\\\\\\":1 \\\\\\"lastUrgeTime\\\\\\":0 \\\\\\"queueId\\\\\\":0 \\\\\\"sopCateId\\\\\\":252011 \\\\\\"totalUrgeMemo\\\\\\":\\\\\\"\\\\\\" \\\\\\"taskGmtModified\\\\\\":0 \\\\\\"departmentId\\\\\\":10 \\\\\\"groupId\\\\\\":0 \\\\\\"channelType\\\\\\":1 \\\\\\"questionInfo\\\\\\":\\\\\\"\\\\\\" \\\\\\"templateId\\\\\\":0 \\\\\\"deadLine\\\\\\":0 \\\\\\"srType\\\\\\":30701 \\\\\\"caseId\\\\\\":2000000001165962}\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<QueryTicketsResponse>\\n <Code>200</Code>\\n <Message>xxxx</Message>\\n <Data>{ \\"totalResults\\":1 \\"previousPage\\":1 \\"data\\":[ 0:{ \\"serviceType\\":1 \\"lastUrgeTime\\":0 \\"queueId\\":0 \\"sopCateId\\":252011 \\"totalUrgeMemo\\":\\"\\" \\"taskGmtModified\\":0 \\"departmentId\\":10 \\"groupId\\":0 \\"channelType\\":1 \\"questionInfo\\":\\"\\" \\"templateId\\":0 \\"deadLine\\":0 \\"srType\\":30701 \\"caseId\\":2000000001165962}</Data>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Success>true</Success>\\n</QueryTicketsResponse>","errorExample":""}]', - 'title' => 'QueryTickets', + ['errorMessage' => 'The operation is invalid.', 'errorCode' => 'InvalidOperation', 'description' => ''], + ['errorMessage' => 'The specified agent does not exist.', 'errorCode' => 'NoAgentFound', 'description' => ''], + ['errorMessage' => 'The specified tenant does not exist.', 'errorCode' => 'NoTenantFound', 'description' => ''], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update Agent Data', + 'summary' => 'Modify agent information in the Cloud Customer Service System based on the instance ID and agent account name. You can modify the agent\'s display name and the skill groups to which the agent belongs.'."\n", + 'description' => '- Before invoking this API, we recommend that you confirm your Artificial Intelligence Cloud Call Service (AICCS) instance ID. For guidance on how to obtain it, see the description of [Request Parameters](#api-detail-35).'."\n" + .'- After the update, you can invoke the [GetAgent](~~2717961~~) API to confirm whether the update meets your expectations.'."\n" + ."\n" + .'> Currently, only the display name and assigned skill groups can be modified.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API-wide invocation frequency: 100 queries per second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API-wide frequency limit.'."\n", + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'RestartOutboundTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateAiCallTask' => [ + 'summary' => 'Updates a call task configuration.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ - 'name' => 'OutboundTaskId', + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => ['description' => 'The task name. The name must be unique within an Alibaba Cloud account.', 'type' => 'string', 'required' => true, 'example' => '测试任务', 'title' => ''], + ], + [ + 'name' => 'VirtualNumber', + 'in' => 'query', + 'schema' => ['description' => 'The service instance used for outbound calls.', 'type' => 'string', 'required' => true, 'example' => '0537022*****', 'title' => ''], + ], + [ + 'name' => 'StartType', + 'in' => 'query', + 'schema' => ['description' => 'The startup method. Valid values:'."\n" + ."\n" + .'- `IMMEDIATE`: Start immediately.'."\n" + ."\n" + .'- `SCHEDULE`: Start at a specified time.', 'type' => 'string', 'required' => true, 'example' => 'IMMEDIATE', 'title' => ''], + ], + [ + 'name' => 'MissCallRetry', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable retry. Valid values:'."\n" + ."\n" + .'- `true`: Yes.'."\n" + ."\n" + .'- `false` (default): No.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'CallRetryReason', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', + 'description' => 'The call failure statuses that trigger a retry.', + 'type' => 'array', + 'items' => [ + 'description' => 'A call failure status that triggers a retry. Valid values:'."\n" + ."\n" + .'- `CALL_REJECTED`: The call was rejected.'."\n" + ."\n" + .'- `USER_BUSY`: The user is busy.'."\n" + ."\n" + .'- `SUSPEND`: The service is suspended.'."\n" + ."\n" + .'- `INVALID_NUMBER`: The number is invalid.'."\n" + ."\n" + .'- `POWERED_OFF`: The phone is powered off.'."\n" + ."\n" + .'- `NETWORK_BUSY`: The network is busy.'."\n" + ."\n" + .'- `NO_ANSWER`: No answer.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'CALL_REJECTED', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'InstanceId', + 'name' => 'CallRetryTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of retries. The maximum value is 3.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'CallRetryInterval', 'in' => 'query', + 'schema' => ['description' => 'The retry interval in minutes. The maximum value is 120.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '25', 'title' => ''], + ], + [ + 'name' => 'CallTime', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The callable time windows.', + 'type' => 'array', + 'items' => ['description' => 'The time window for calls. The format is as follows:'."\n" + ."\n" + .'```json'."\n" + .'{"startTime":"09:00:00","endTime":"10:00:00"}'."\n" + .'```'."\n" + ."\n" + .'In this format, `startTime` and `endTime` define the start and end of a time window. The system makes outbound calls only during these windows. If a call is scheduled outside a time window, the system waits for the next available window to begin.'."\n" + ."\n" + .'> - Due to carrier policies, the actual execution time is subject to platform scheduling. You can check the restricted calling periods for your numbers in [Real Number Management](https://dyvms.console.aliyun.com/number/list/normal).', 'type' => 'string', 'required' => false, 'example' => '{"startTime":"09:00:00","endTime":"10:00:00"}', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'CallDay', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The days of the week when calls can be made.', + 'type' => 'array', + 'items' => [ + 'description' => 'A day of the week on which calls can be made. Valid values:'."\n" + ."\n" + .'- `MONDAY`: Monday.'."\n" + ."\n" + .'- `TUESDAY`: Tuesday.'."\n" + ."\n" + .'- `WEDNESDAY`: Wednesday.'."\n" + ."\n" + .'- `THURSDAY`: Thursday.'."\n" + ."\n" + .'- `FRIDAY`: Friday.'."\n" + ."\n" + .'- `SATURDAY`: Saturday.'."\n" + ."\n" + .'- `SUNDAY`: Sunday.', + 'enumValueTitles' => ['WEDNESDAY' => '', 'MONDAY' => '', 'THURSDAY' => '', 'SUNDAY' => '', 'TUESDAY' => '', 'FRIDAY' => '', 'SATURDAY' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'MONDAY', + 'title' => '', + ], 'required' => true, - 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'TaskStartTime', + 'in' => 'query', + 'schema' => ['description' => 'The scheduled start time for the task, specified as a Unix timestamp in milliseconds. This parameter is required when `StartType` is set to `SCHEDULE`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1748923429000', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the task to update.', 'type' => 'string', 'required' => true, 'example' => '1187**************', 'title' => ''], + ], + [ + 'name' => 'TaskCps', + 'in' => 'query', + 'schema' => ['description' => 'The number of concurrent calls per second (CPS) for the task. The maximum value is 500.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '57', 'default' => '', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], + 'AccessDeniedDetail' => ['description' => 'The reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned when an error occurs.', 'type' => 'string', 'example' => '参数不合法', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'FCD94A7F-316D-54D1-9BFC-814006CB1C34', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the task was updated successfully. Valid values:'."\n" + ."\n" + .'- **true**: The update is successful.'."\n" + ."\n" + .'- **false**: The update failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + ."\n" + .'- **true**: Successful.'."\n" + ."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"参数不合法\\",\\n \\"RequestId\\": \\"FCD94A7F-316D-54D1-9BFC-814006CB1C34\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Update the outbound call job configuration of the communication agent', + 'description' => 'Ensure the call task is stopped before you update its configuration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAiCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, ], - 'StartCallV2' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateAiOutboundTask' => [ + 'summary' => 'Update an outbound call job by instance ID and job ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).'."\n", 'example' => 'agent_***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The job ID.'."\n" + ."\n" + .'You can invoke the [CreateAiOutboundTask](~~312260~~) API and check the **Data** field in the response, or invoke the [GetAiOutboundTaskList](~~2718026~~) API and check the **TaskId** field in the response.', 'example' => '123', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123@123.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'Job name. Length: 1 to 15 characters.', 'example' => 'xxxx外呼', 'maxLength' => 15, 'minLength' => 1, 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'Caller', - 'in' => 'formData', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The job description. It can contain 0 to 100 characters.', 'example' => '房产销售', 'maxLength' => 100, 'required' => false, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'OutboundNums', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '9065****', + 'description' => 'Outbound caller numbers.', + 'items' => ['description' => 'Outbound caller number.', 'example' => '150****0000', 'required' => true, 'type' => 'string', 'title' => ''], 'required' => true, - 'type' => 'string', + 'title' => '', + 'type' => 'array', + 'example' => '', ], ], [ - 'name' => 'CallerType', - 'in' => 'formData', + 'name' => 'NumRepeated', + 'in' => 'query', 'schema' => [ - 'description' => '', - 'docRequired' => true, + 'description' => 'The policy for handling duplicate callee numbers.'."\n" + .'- **0**: Remove duplicates within the job.'."\n" + .'- **1**: Do not remove duplicates within the job.', 'example' => '1', 'format' => 'int32', 'required' => true, + 'title' => '', 'type' => 'integer', - 'enum' => [ - '1', - '2', - ], + 'enum' => ['0', '1'], ], ], [ - 'name' => 'Callee', - 'in' => 'formData', + 'name' => 'HandlerId', + 'in' => 'query', + 'schema' => ['description' => 'The skill group ID (for predictive outbound calls) or IVR ID (for automated outbound calls).', 'example' => '123', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'ExecutionTime', + 'in' => 'query', + 'schema' => ['description' => 'The job execution time.'."\n" + ."\n" + .'> The end time must be later than the start time.', 'example' => '{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]}', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'ConcurrentRate', + 'in' => 'query', + 'schema' => ['description' => 'The concurrent rate for automated outbound calls.', 'example' => '10', 'format' => 'int32', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + [ + 'name' => 'RecallRule', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '136****1111', - 'required' => true, - 'type' => 'string', + 'description' => 'Failed-call retry policy.'."\n" + ."\n" + .'> If empty, no retry is performed when an outbound call fails.', + 'properties' => [ + 'Count' => ['description' => 'Number of retries after a failed call. Valid values: **1 to 3**.', 'example' => '2', 'format' => 'int32', 'maximum' => '3', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], + 'Interval' => ['description' => 'Time interval between retries after a failed call. Valid values: **1 to 60**, unit: minutes.', 'example' => '5', 'format' => 'int32', 'maximum' => '60', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'integer'], + ], + 'required' => false, + 'title' => '', + 'type' => 'object', + 'example' => '', ], ], + [ + 'name' => 'ForecastCallRate', + 'in' => 'query', + 'schema' => ['description' => 'Fixed dialing ratio for predictive outbound calls. Valid values: **≥1**.', 'example' => '1.2', 'format' => 'float', 'maximum' => '100', 'minimum' => '1', 'required' => false, 'title' => '', 'type' => 'number'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', + 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'ok', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'example' => 'ok', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API invocation succeeded.'."\n" + .'- **true**: Succeeded.'."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"ok\\",\\n \\"Code\\": \\"ok\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update Outbound Call Job', + 'description' => 'This API supports updating information such as the task name, task description, outbound caller number, and skill group ID. For details, see [Request Parameters](#api-detail-35).'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user invocation frequency: No rate limiting.'."\n" + .'- API frequency: 20 times per second.'."\n" + ."\n" + .'> Throttling is triggered if the total invocations from multiple users exceed the API frequency limit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartCallV2Response>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Code>Success</Code>\\n <Success>true</Success>\\n</StartCallV2Response>","errorExample":""}]', - 'title' => 'StartCallV2', + 'ramActions' => [], ], - 'StartChatWork' => [ - 'summary' => '修改在线客服为上班状态', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateDepartment' => [ + 'summary' => 'Update the department name based on the Artificial Intelligence Cloud Call Service (AICCS) instance ID and department ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -28227,35 +20375,29 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'ccc_xp_pre***', - 'required' => true, - 'title' => 'instanceId', - 'type' => 'string', - ], + 'in' => 'query', + 'schema' => ['description' => 'The Artificial Intelligence Cloud Call Service (AICCS) instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview).', 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'title' => '', 'type' => 'string'], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '123@123.com', - 'required' => true, - 'title' => 'accountName', - 'type' => 'string', - ], + 'name' => 'DepartmentName', + 'in' => 'query', + 'schema' => ['description' => 'The department name.'."\n" + ."\n" + .'> This parameter supports updates.', 'example' => '部门A', 'required' => true, 'title' => '', 'type' => 'string'], + ], + [ + 'name' => 'DepartmentId', + 'in' => 'query', + 'schema' => ['description' => 'The department ID.'."\n" + ."\n" + .'You can invoke the [GetAllDepartment](~~2717975~~) API and view the **DepartmentId** field in the response to obtain the department ID.'."\n" + ."\n" + .'> This parameter does not support updates.', 'example' => '12****', 'format' => 'int64', 'required' => true, 'title' => '', 'type' => 'integer'], ], ], 'responses' => [ @@ -28263,235 +20405,145 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'title' => 'message', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'title' => 'requestId', - 'type' => 'string', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'example' => '200', - 'format' => 'int32', - 'title' => 'httpStatusCode', - 'type' => 'integer', - ], - 'Data' => [ - 'description' => '', - 'example' => '1', - 'title' => 'data', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'title' => 'code', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'title' => 'success', - 'type' => 'boolean', - ], + 'RequestId' => ['description' => 'The request ID.', 'example' => '98B032F5-6473-4EAC-8BA8-C28993513A1', 'title' => 'Id of the request', 'type' => 'string'], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'example' => '200', 'format' => 'int64', 'type' => 'integer', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values: '."\n" + .'- **true**: Succeeded '."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API was invoked successfully. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], - 'title' => 'result', + 'title' => 'Schema of Response', 'type' => 'object', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - '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.', - 'errorCode' => 'IdempotentParameterMismatch', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"1\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<StartChatWorkResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <HttpStatusCode>200</HttpStatusCode>\\n <Data>1</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</StartChatWorkResponse>","errorExample":""}]', - 'title' => 'StartChatWork', + 500 => [ + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98B032F5-6473-4EAC-8BA8-C28993513A1\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update Department Information', + 'description' => '- This API supports updating only the department name and does not support updating the department ID. '."\n" + .'- Before invoking this API, we recommend that you confirm the AICCS instance ID and department ID. For guidance on how to obtain them, see the instructions in [Request Parameters](#api-detail-35). '."\n" + .'- After the update is complete, you can invoke the [GetAllDepartment](~~2717975~~) API to confirm whether the department information matches your expectations.'."\n" + ."\n" + .'### Queries per second (QPS) limits'."\n" + .'- Per-user invocation frequency: 100 times/second. '."\n" + .'- API-wide invocation frequency: 100 times/second.'."\n" + ."\n" + .'> If the total invocations from multiple users exceed the API-wide frequency limit, throttling will be triggered.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T12:37:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDepartment'], + ], + ], + 'ramActions' => [], ], - 'StartMicroOutbound' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateLargeModel' => [ + 'summary' => 'Updates a large language model.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'abilityTreeCode' => '255141', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], ], 'parameters' => [ [ - 'name' => 'ProdCode', + 'name' => 'ModelCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'aiccs', - 'required' => false, - 'type' => 'string', - 'default' => 'aiccs', - ], + 'schema' => ['description' => 'The model code.', 'type' => 'string', 'required' => false, 'example' => 'Test Model Name', 'title' => ''], ], [ - 'name' => 'AccountType', + 'name' => 'ModelName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'BUC_TYPE', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The model name.', 'type' => 'string', 'required' => false, 'example' => 'Test model', 'title' => ''], ], [ - 'name' => 'AccountId', + 'name' => 'ModelUrl', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '223457****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The model URL.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxx', 'title' => ''], ], [ - 'name' => 'CommandCode', + 'name' => 'AuthCode', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'outBound_Call', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The authorization code.', 'type' => 'string', 'required' => false, 'example' => 'sk-sxxxxx*********xx', 'title' => ''], ], [ - 'name' => 'CallingNumber', + 'name' => 'Temperature', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '1367123****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Controls the randomness of the model\'s output. A higher value increases randomness, and a lower value makes the output more deterministic.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], ], [ - 'name' => 'CalledNumber', + 'name' => 'TopP', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '0571456****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Controls output diversity by using nucleus sampling. It defines a cumulative probability threshold for token selection, considering only the most likely tokens.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.1', 'title' => ''], ], [ - 'name' => 'ExtInfo', + 'name' => 'TopK', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '{"caseId":23232****}', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Restricts token selection to the top k most probable tokens.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'AppName', + 'name' => 'BaseModel', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'example' => 'aliyun', + 'description' => 'A list of base models.', + 'type' => 'array', + 'items' => ['description' => 'The name of a base model.', 'type' => 'string', 'required' => false, 'example' => 'qwen-max', 'title' => ''], 'required' => false, - 'type' => 'string', + 'example' => '', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Schema of Response', - 'properties' => [ - 'InvokeCreateTime' => [ - 'description' => '', - 'example' => '2019-05-23 17:30:32.525', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'example' => 'OK', - 'type' => 'string', - ], - 'InvokeCmdId' => [ - 'description' => '', - 'example' => '8883f165-4a0d-4da2-a2d2', - 'type' => 'string', - ], - 'CustomerInfo' => [ - 'description' => '', - 'example' => '{\\"caseId\\":2323****}', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - ], 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'Details about an authentication error.', 'type' => 'string', 'example' => 'Access Denied', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'example'], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'title' => '', 'example' => 'example'], + 'Data' => ['description' => 'The result of the update operation.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Code' => ['description' => 'The status code returned for the request.', 'type' => 'string', 'title' => '', 'example' => '200'], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => 'The response object.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorMessage' => 'Insufficient permissions. Please contact the primary account administrator.', - 'errorCode' => 'Permission.NotAuthorized', - ], - [ - 'errorMessage' => 'Parameter error.', - 'errorCode' => 'Parameter.Error', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'UpdateLargeModel', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"InvokeCreateTime\\": \\"2019-05-23 17:30:32.525\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Message\\": \\"OK\\",\\n \\"InvokeCmdId\\": \\"8883f165-4a0d-4da2-a2d2\\",\\n \\"CustomerInfo\\": \\"{\\\\\\\\\\\\\\"caseId\\\\\\\\\\\\\\":2323****}\\",\\n \\"Code\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"<StartMicroOutboundResponse>\\n <InvokeCreateTime>2019-05-23 17:30:32.525</InvokeCreateTime>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Message>OK</Message>\\n <InvokeCmdId>8883f165-4a0d-4da2-a2d2</InvokeCmdId>\\n <CustomerInfo>{\\\\\\"caseId\\\\\\":2323****}</CustomerInfo>\\n <Code>200</Code>\\n</StartMicroOutboundResponse>","errorExample":""}]', - 'title' => 'StartMicroOutbound', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Message\\": \\"example\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'SuspendOutboundTask' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateModelApplication' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28500,508 +20552,352 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '254049', + 'abilityTreeNodes' => ['FEATUREaiccsA3JJUR'], 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'OutboundTaskId', + 'name' => 'ApplicationName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775700', - 'minimum' => '0', - ], + 'schema' => ['description' => 'The name of the model application.', 'type' => 'string', 'required' => false, 'example' => '测试应用', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'ApplicationCode', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - ], + 'schema' => ['description' => 'The application code.', 'type' => 'string', 'required' => true, 'example' => ' DKSDLSA', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Message' => [ - 'type' => 'string', - ], - 'RequestId' => [ - 'type' => 'string', - ], - 'Data' => [ - 'type' => 'string', - ], - 'Code' => [ - 'type' => 'string', - ], - 'Success' => [ - 'type' => 'boolean', - ], - ], - ], + [ + 'name' => 'ApplicationCps', + 'in' => 'query', + 'schema' => ['description' => 'The number of concurrent requests for the application.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12', 'title' => ''], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + [ + 'name' => 'ModelCode', + 'in' => 'query', + 'schema' => ['description' => 'The model code.', 'type' => 'string', 'required' => false, 'example' => '1231', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => null, - ], - 'UpdateOuterAccount' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'ModelVersion', + 'in' => 'query', + 'schema' => ['description' => 'The model version.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'OuterAccountId', + 'name' => 'QualificationId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The qualification ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '61', 'title' => ''], ], [ - 'name' => 'OuterAccountType', + 'name' => 'QualificationName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'alipay', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'The name of the qualification.', 'type' => 'string', 'required' => false, 'example' => '测试质检', 'title' => ''], ], [ - 'name' => 'OuterAccountName', + 'name' => 'SpeechId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The speech ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], ], [ - 'name' => 'Avatar', + 'name' => 'SpeechContent', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'http://****', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The content of the speech.', 'type' => 'string', 'required' => false, 'example' => '测试话术', 'title' => ''], ], [ - 'name' => 'RealName', + 'name' => 'UsageDesc', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The purpose of the application.', 'type' => 'string', 'required' => false, 'example' => '测试用途', 'title' => ''], ], [ - 'name' => 'OuterDepartmentId', + 'name' => 'DyvmsSceneName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '3', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The scene name.', 'type' => 'string', 'required' => false, 'example' => '测试场景', 'title' => ''], ], [ - 'name' => 'OuterGroupIds', + 'name' => 'StartWord', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '["222","333","444"]', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The opening statement.', 'type' => 'string', 'required' => false, 'example' => '你好，这是个测试开场白', 'title' => ''], ], [ - 'name' => 'Ext', + 'name' => 'StartWordType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The type of the opening statement. Valid values:', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0：文本'."\n" + .'1：录音'."\n", 'title' => ''], ], [ - 'name' => 'OuterGroupType', + 'name' => 'RecordingFile', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'mybank', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The URL of the recording file.', 'type' => 'string', 'required' => false, 'example' => 'https://xxxxxxxxxxxxxxx.wav', 'title' => ''], ], [ - 'name' => 'OuterDepartmentType', + 'name' => 'Prompt', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'type_invalid', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'The prompt.', 'type' => 'string', 'required' => false, 'example' => '测试提示词', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TtsConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Schema of Response', + 'description' => 'The TTS configuration, such as voice, volume, and speech rate.', + 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'VoiceCode' => ['description' => 'The voice code.', 'type' => 'string', 'required' => false, 'example' => '12123213123', 'title' => ''], + 'MixingTemplate' => ['description' => 'The mixing template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'BackgroundEnabled' => ['description' => 'Specifies whether to enable background sound.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TtsVolume' => ['description' => 'The TTS playback volume. Valid values range from 0 to 100. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11', 'title' => ''], + 'TtsStyle' => ['description' => 'The voice style.', 'type' => 'string', 'required' => false, 'example' => 'voice', 'title' => ''], + 'ResourceId' => ['description' => 'The resource ID.', 'type' => 'string', 'required' => false, 'example' => '122', 'title' => ''], + 'CustomerAccountId' => ['description' => 'The account ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '47', 'title' => ''], + 'VoiceType' => ['description' => 'The voice type. Valid values:'."\n" + ."\n" + .'```'."\n" + .'SYSTEM: System voice.'."\n" + .'COSYCLONE: Cloned voice.'."\n" + .'BL-CUSTOM: Premium custom-cloned voice.'."\n" + .'```', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM', 'title' => ''], + 'MixingEnabled' => ['description' => 'Specifies whether to enable audio mixing.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TtsSpeed' => ['description' => 'The TTS playback speech rate. Valid values range from -200 to 200. The default value is 0.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7', 'title' => ''], + 'BackgroundSound' => ['description' => 'The background sound ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], + 'BackgroundVolume' => ['description' => 'The volume of the background sound. Valid values: `0` (low), `1` (medium), and `2` (high).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], - 'type' => 'object', + 'required' => false, + 'example' => '', + 'title' => '', ], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + [ + 'name' => 'MuteDuration', + 'in' => 'query', + 'schema' => ['description' => 'The mute duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '85', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdateOuterAccountResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>true</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</UpdateOuterAccountResponse>","errorExample":""}]', - 'title' => 'UpdateOuterAccount', - ], - 'TransferCallToSkillGroup' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'MuteActive', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the first mute event triggers the model.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'BearerToken' => [], + 'name' => 'MutePushMode', + 'in' => 'query', + 'schema' => ['description' => '静音事件推送模式', 'type' => 'string', 'required' => false, 'example' => 'FIRST_ONLY', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '46c1341e-2648-447a-9b11-70b6a298d94d', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'MuteHangupNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of consecutive mute events that trigger an automatic hang-up.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '70', 'title' => ''], ], [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'ccc_xp_pre-cn-***', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CallAssistantRecognize', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable call assistant recognition.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'username@example.com', - 'required' => true, - 'type' => 'string', - ], + 'name' => 'CallAssistantHangup', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to hang up the call when a call assistant is detected.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'SkillGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '356543', - 'format' => 'int64', - 'required' => true, - 'type' => 'integer', - ], + 'name' => 'EnableMorse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the Morse code configuration. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'CallId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719786', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'SessionTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The session timeout, which is the maximum duration of a call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '49', 'title' => ''], ], [ - 'name' => 'JobId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719787', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The value must be `USER`.', 'type' => 'string', 'required' => false, 'example' => 'USER', 'title' => ''], ], [ - 'name' => 'ConnectionId', - 'in' => 'formData', + 'name' => 'InterruptConfig', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '7719788', + 'description' => 'The interruption configuration.', + 'type' => 'object', + 'properties' => [ + 'EnableStartwordEntireNotInterrupt' => ['description' => 'Specifies whether to make the entire opening statement non-interruptible.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'EnableAvoidInterrupt' => ['description' => 'Specifies whether to prevent consecutive barge-ins.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'EnableStartwordNotInterrupt' => ['description' => 'Specifies whether to make the opening statement non-interruptible.', 'type' => 'boolean', 'required' => false, 'example' => '', 'title' => ''], + 'StartwordProtectDuration' => ['description' => 'The protection duration for the opening statement, in seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.4699', 'title' => ''], + 'EnableInterruptBackchannel' => ['description' => 'Specifies whether to enable the backchannel configuration for interruptions.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'AvoidInterruptDTO' => [ + 'description' => 'The configuration to prevent consecutive barge-ins.', + 'type' => 'object', + 'properties' => [ + 'InterruptProtectDuration' => ['description' => 'The interruption protection duration, in seconds.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '16.417547', 'title' => ''], + 'InterruptNum' => ['description' => 'The number of consecutive interruptions.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + 'required' => false, + 'example' => '', + 'title' => '', + ], + ], 'required' => false, - 'type' => 'string', + 'example' => '', + 'title' => '', ], ], [ - 'name' => 'HoldConnectionId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '0', - 'required' => false, - 'type' => 'string', - ], + 'name' => 'EnableDtmfReceive', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the collection of DTMF signals. The default value is `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => '1', - 'format' => 'int32', - 'maximum' => '2', - 'minimum' => '1', - 'required' => false, - 'type' => 'integer', - 'default' => '1', - ], + 'name' => 'DtmfInputTimeout', + 'in' => 'query', + 'schema' => ['description' => 'The timeout for DTMF input, in seconds. The value must be between 1 and 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'IsSingleTransfer', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'example' => 'true', - 'required' => false, - 'type' => 'boolean', - ], + 'name' => 'DtmfDigitCount', + 'in' => 'query', + 'schema' => ['description' => 'The number of DTMF digits to collect. The value must be between 1 and 12.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DtmfAutoValidateEnable', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to automatically validate the DTMF digits.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DtmfAllowedDigits', + 'in' => 'query', + 'schema' => ['description' => 'The allowed DTMF digits, specified as a comma-separated string such as `1,2,3`. You can specify a maximum of 20 digits.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DtmfOutOfRangeAction', + 'in' => 'query', + 'schema' => ['description' => 'The action to take when the input is outside the allowed range. Valid values: `RETURN_MODEL` and `AUTO_RETRY`.', 'type' => 'string', 'required' => false, 'example' => 'RETURN_MODEL ', 'title' => ''], + ], + [ + 'name' => 'DtmfRetryPlayTimes', + 'in' => 'query', + 'schema' => ['description' => 'The number of retry attempts. The value must be between 1 and 3. This parameter is effective only when `DtmfOutOfRangeAction` is set to `AUTO_RETRY`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DtmfRetryPromptText', + 'in' => 'query', + 'schema' => ['description' => 'The custom text for the retry prompt. The text can contain a maximum of 50 characters. If this parameter is empty, the system uses the default prompt: "Invalid input. Please try again."', 'type' => 'string', 'required' => false, 'example' => '测试文本', 'title' => ''], + ], + [ + 'name' => 'EnableDtmfSend', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'required' => false, 'example' => 'true', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'DtmfSendWaitTimeout', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'DtmfSendMaxCount', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '90', 'description' => '', 'title' => ''], + ], + [ + 'name' => 'CallConnectedTriggerModel', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to trigger the model immediately after the call is connected.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'result', - 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - ], 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D9CB3933-9FE3-4870-BA8E-2BEE91B69D23'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'title' => '', 'example' => 'successful'], + 'Data' => ['description' => 'The data returned by the request.', 'type' => 'string', 'title' => '', 'example' => 'DKSDLSA'], + 'Code' => ['description' => 'The status code. A value of OK indicates that the request was successful.', 'type' => 'string', 'title' => '', 'example' => 'OK'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- **true**: The request was successful.'."\n" + ."\n" + .'- **false**: The request failed.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'description' => 'The response body.', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'The specified tenant does not exist.', - 'errorCode' => 'NoTenantFound', - ], - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateModelApplication', + 'summary' => 'Edit Model Application', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"D9CB3933-9FE3-4870-BA8E-2BEE91B69D23\\",\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": \\"DKSDLSA\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'AddSkillGroup' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateOuterAccount' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OuterGroupId', + 'name' => 'OuterAccountId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '123456', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'External account ID.', 'docRequired' => true, 'example' => '123456', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OuterGroupName', + 'name' => 'OuterAccountType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => '', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'External account type.', 'docRequired' => true, 'example' => 'alipay', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OuterGroupType', + 'name' => 'OuterAccountName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'docRequired' => true, - 'example' => 'mybank', - 'required' => true, - 'type' => 'string', - ], + 'schema' => ['description' => 'External account name.', 'example' => '测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Avatar', + 'in' => 'query', + 'schema' => ['description' => 'Profile picture.', 'example' => 'http://****', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'RealName', + 'in' => 'query', + 'schema' => ['description' => 'Real name of the account.', 'example' => '张三', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'External department ID.', 'example' => '3', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'List of external skill group IDs. Separate multiple IDs with commas (,).', 'example' => '["222","333","444"]', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Ext', + 'in' => 'query', + 'schema' => ['description' => 'Extension field. A JSON string.', 'example' => '{"备注":"临时技能组"}', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'OuterGroupType', + 'in' => 'query', + 'schema' => ['description' => 'Skill group type.', 'example' => 'mybank', 'required' => false, 'type' => 'string', 'title' => ''], ], [ 'name' => 'OuterDepartmentType', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => 'type_invalid', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'External department type: invalid department type.', 'example' => 'type_invalid', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -29009,91 +20905,87 @@ 'schema' => [ 'description' => 'Schema of Response', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => '123456', - 'type' => 'string', - ], - 'Code' => [ - 'description' => '', - 'example' => '200', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code.', 'example' => 'xxxx', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID.', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the operation succeeded. Valid values:'."\n" + ."\n" + .'- **true**: Succeeded'."\n" + .'- **false**: Failed', 'example' => 'true', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A value of 200 indicates that the request succeeded.', 'example' => '200', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], + ['errorMessage' => 'A system error occurred. Please contact the administrator.', 'errorCode' => 'SystemError', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update External Account Information', + 'summary' => 'Invoke UpdateOuterAccount to update an external account based on the external account ID.', + 'changeSet' => [ + ['createdAt' => '2021-06-01T14:36:01.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": \\"123456\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<AddSkillGroupResponse>\\n <Message>xxxx</Message>\\n <RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n <Data>123456</Data>\\n <Code>200</Code>\\n <Success>true</Success>\\n</AddSkillGroupResponse>","errorExample":""}]', - 'title' => 'AddSkillGroup', - ], - 'DeleteSkillGroup' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateSkillGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ - 'name' => 'OuterGroupType', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '2', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'AICCS instance ID. '."\n" + .'You can obtain it from **Instance Management** in the left-side navigation pane of the [Artificial Intelligence Cloud Call Service console](https://aiccs.console.aliyun.com/overview). ', 'docRequired' => true, 'example' => 'ccc_xp_pre-cn-***', 'required' => true, 'type' => 'string', 'title' => ''], ], [ - 'name' => 'OuterGroupId', + 'name' => 'SkillGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'example' => '123456', - 'required' => false, - 'type' => 'string', - ], + 'schema' => ['description' => 'Skill group ID. '."\n" + ."\n" + .'You can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API and check the **SkillGroupId** field in the response to obtain the skill group ID. '."\n" + ."\n" + .'> This parameter cannot be updated. ', 'docRequired' => true, 'example' => '123456', 'format' => 'int64', 'maximum' => '9223372036854775807', 'minimum' => '1', 'required' => true, 'type' => 'integer', 'title' => ''], + ], + [ + 'name' => 'SkillGroupName', + 'in' => 'query', + 'schema' => ['description' => 'Skill group name. '."\n" + .'> This parameter cannot be updated. ', 'example' => '自动化测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Skill group description. '."\n" + .'> This parameter can be updated. ', 'example' => '自动化测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'query', + 'schema' => ['description' => 'Display name of the skill group. '."\n" + .'> This parameter can be updated. ', 'example' => '自动化测试', 'required' => false, 'type' => 'string', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'Unique ID of the customer request. Used for idempotency validation. You can generate it by using a UUID. ', 'example' => '46c1341e-2648-447a-****-70b6a298d94d', 'required' => false, 'type' => 'string', 'title' => ''], ], ], 'responses' => [ @@ -29101,266 +20993,988 @@ 'schema' => [ 'description' => 'result', 'properties' => [ - 'Message' => [ - 'description' => '', - 'example' => 'xxxx', - 'type' => 'string', - ], - 'RequestId' => [ - 'description' => '', - 'example' => 'EE338D98-9BD3-4413-B165', - 'type' => 'string', - ], - 'Data' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], - 'Code' => [ - 'description' => '', - 'example' => 'Success', - 'type' => 'string', - ], - 'Success' => [ - 'description' => '', - 'example' => 'true', - 'type' => 'boolean', - ], + 'Message' => ['description' => 'Description of the status code. ', 'example' => 'successful', 'type' => 'string', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. ', 'example' => 'EE338D98-9BD3-4413-B165', 'type' => 'string', 'title' => ''], + 'Code' => ['description' => 'Status code. A return value of "Success" indicates that the request succeeded. ', 'example' => 'Success', 'type' => 'string', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded. Valid values: '."\n" + .'- **true**: Succeeded. '."\n" + .'- **false**: Failed. ', 'example' => 'true', 'type' => 'boolean', 'title' => ''], ], 'type' => 'object', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 500 => [ - [ - 'errorMessage' => 'A system error occurred. Please contact the administrator.', - 'errorCode' => 'SystemError', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Message\\": \\"xxxx\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<Message>xxxx</Message>\\n<RequestId>EE338D98-9BD3-4413-B165</RequestId>\\n<Data>true</Data>\\n<Code>Success</Code>\\n<Success>true</Success>","errorExample":""}]', + 400 => [ + ['errorMessage' => 'The specified instance is unavailable or does not exist.', 'errorCode' => 'InvalidInstanceId', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"EE338D98-9BD3-4413-B165\\",\\n \\"Code\\": \\"Success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Modify a Skill Group '."\n", + 'summary' => 'Update the skill group information in the Cloud Customer Service System based on the AICCS instance ID and skill group ID. This API supports updating the skill group description and display name.'."\n", + 'description' => '- This API does not support updating the skill group ID or skill group name. '."\n" + .'- After the update, you can invoke the [QuerySkillGroups](https://help.aliyun.com/zh/aiccs/developer-reference/api-aiccs-2019-10-15-queryskillgroups) API to query the skill group information. '."\n" + .'- If you need to provide the AICCS instance ID and skill group ID, refer to the instructions in the [Request Parameters](#api-detail-35) section.'."\n" + ."\n" + .'### Queries per second (QPS) limit'."\n" + .'- Per-user call frequency: No rate limiting.'."\n" + .'- API call frequency: 1000 calls per second.'."\n" + ."\n" + .'> If the total calls from multiple users exceed the API frequency limit, throttling will be triggered.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], ], 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'CorpusCreateFailure', 'message' => 'Failed to create the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'CorpusDeleteFailure', 'message' => 'Failed to delete the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'Department.NotFound', 'message' => 'The specified department does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Forbidden.Operation', 'message' => 'No permissions for this operation.', 'http_code' => 400, 'description' => 'No operation permission'], + ['code' => 'InvalidCustomer.NotFound', 'message' => 'Failed to query customers.', 'http_code' => 400, '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' => 'InvalidParameter.ApplicationCode', 'message' => 'The specified parameter "ApplicationCode" is invalid.', 'http_code' => 400, 'description' => 'The parameter ApplicationCode is invalid.'], + ['code' => 'InvalidParameter.CallDate', 'message' => 'The specified parameter "CallDate" is not valid.', 'http_code' => 400, 'description' => 'Invalid CallDate.'], + ['code' => 'InvalidParameter.CallId', 'message' => 'The parameter CallId is invalid.', 'http_code' => 400, 'description' => 'The parameter CallId is invalid.'."\n"], + ['code' => 'InvalidPartnerId.NotFound', 'message' => 'You must specify PartnerId.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserInfo.Exception', 'message' => 'Failed to query user information.', 'http_code' => 400, 'description' => ''], + ['code' => 'INVALID_SUMMARY_AGENT', 'message' => 'summary agent is invalid.', 'http_code' => 400, 'description' => 'Subtotal Intelligence Illegal'], + ['code' => 'INVALID_TASK_NAME', 'message' => 'taskName is invalid.', 'http_code' => 400, 'description' => 'Invalid task name'], + ['code' => 'MissingParameter.CallerNumber', 'message' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'http_code' => 400, 'description' => 'The request required parameter "CallerNumber" was not provided ".'], + ['code' => 'ModelCreateFailure', 'message' => 'Failed to create the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelDeleteFailure', 'message' => 'Failed to delete the the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelNotExist', 'message' => 'The model does not exist.', 'http_code' => 400, 'description' => 'The model does not exist.'], + ['code' => 'ModelStatus.Invalid', 'message' => 'Model state invalid.', 'http_code' => 400, 'description' => 'Invalid model state.'], + ['code' => 'ModelUpperLimitReached', 'message' => 'The maximum number of models is exceeded.', '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' => 'Parameter.Error', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => ''], + ['code' => 'Parameter.Exception', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Permission.NotAuthorized', 'message' => 'Insufficient permissions. Please contact the primary account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'PermissionInsufficient', 'message' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'RequestParamError', 'message' => 'The request parameter you sent is abnormal. Please check.', 'http_code' => 501, 'description' => 'The request parameter you sent is abnormal. Please check!'], + ['code' => 'SUMMARY_AGENT_NOT_ONLINE', 'message' => 'summary agent is not online.', 'http_code' => 400, 'description' => 'Subtotal intelligences not online'], + ['code' => 'SystemError', 'message' => 'A system error occurred. Please contact the administrator.', 'http_code' => 500, 'description' => ''], + ['code' => 'SystemHandleFail', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => 'A system error occurred while processing your request.'], + ['code' => 'TASK_FILE_NOT_EXIST', 'message' => 'task file is not exist.', 'http_code' => 400, 'description' => 'Tasks'], + ['code' => 'TrainFailure', 'message' => 'Model training failed.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabCreateFailure', 'message' => 'Failed to create the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabDeleteFailure', 'message' => 'Failed to delete the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileEmpty', 'message' => 'The vocab file cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileNotExist', 'message' => 'The vocab file does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpdateFailure', 'message' => 'Failed to update the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpperLimitReached', 'message' => 'The maximum number of vocab groups is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each word cannot exceed 10 characters.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each group of vocabs cannot exceed 128 words.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ImportTaskNumberDatas'], + ], + 'createdAt' => '2026-02-02T07:39:07.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ImportTaskNumberDatas'], + ], + 'createdAt' => '2026-02-02T07:38:45.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ImportTaskNumberDatas'], + ], + 'createdAt' => '2026-02-02T07:38:42.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetCallDialogContent'], + ], + 'createdAt' => '2026-01-09T03:56:48.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetCallDialogContent'], + ], + 'createdAt' => '2026-01-09T03:56:35.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAiCallTask'], + ], + 'createdAt' => '2025-12-24T09:12:26.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-huhehaote-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAiCallTask'], + ], + 'createdAt' => '2025-12-24T08:27:56.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LlmSmartCall'], + ], + 'createdAt' => '2025-07-10T15:15:56.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LlmSmartCall'], + ], + 'createdAt' => '2025-05-30T06:28:35.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteAgent'], + ], + 'createdAt' => '2025-05-14T01:42:15.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateAgent'], + ], + 'createdAt' => '2025-05-13T03:56:28.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LlmSmartCall'], + ], + 'createdAt' => '2025-05-13T02:44:32.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LlmSmartCall'], + ], + 'createdAt' => '2025-04-18T03:55:21.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'LlmSmartCall'], + ], + 'createdAt' => '2025-04-14T05:49:38.000Z', + 'description' => '', ], [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetHotlineCallAction'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryTaskResult'], + ['description' => 'Request parameters changed', 'api' => 'StartTaskByApp'], + ], + 'createdAt' => '2022-03-07T06:26:24.000Z', + 'description' => '优化api的标题、描述', ], [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'RemoveAgentFromSkillGroup'], + ], + 'createdAt' => '2021-10-28T02:18:02.000Z', + 'description' => '智能联络中心新增批量移除坐席的技能组接口', ], [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetCallSoundRecord'], + ['description' => 'OpenAPI offline', 'api' => 'ListRobotNode'], + ], + 'createdAt' => '2021-10-21T13:05:31.000Z', + 'description' => 'add OpenAPI', ], [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AiccsSmartCall'], + ['description' => 'Request parameters changed', 'api' => 'SendCcoSmartCall'], + ['description' => 'Request parameters changed', 'api' => 'SendCcoSmartCallOperate'], + ], + 'createdAt' => '2021-09-09T06:05:02.000Z', + 'description' => '更新参数必填', ], [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddHotlineNumber'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteHotlineNumber'], + ['description' => 'OpenAPI offline', 'api' => 'QueryHotlineNumber'], + ['description' => 'OpenAPI offline', 'api' => 'ResetHotlineNumber'], + ], + 'createdAt' => '2021-06-22T12:36:56.000Z', + 'description' => '号码管理api', ], [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryTaskResult'], + ['description' => 'Request parameters changed', 'api' => 'StartTaskByApp'], + ], + 'createdAt' => '2021-06-22T12:03:36.000Z', + 'description' => '云测，运行自动化接口发布变更', ], [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryTaskResult'], + ['description' => 'OpenAPI offline', 'api' => 'StartTaskByApp'], + ], + 'createdAt' => '2021-06-17T07:33:21.000Z', + 'description' => '云测API发布-触发自动化运行', ], [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddOuterAccount'], + ['description' => 'OpenAPI offline', 'api' => 'AddSkillGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteOuterAccount'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteSkillGroup'], + ['description' => 'Error codes changed', 'api' => 'GetCustomerInfo'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentDetailReport'], + ['description' => 'Error codes changed', 'api' => 'GetHotlineAgentStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetIndexCurrentValue'], + ['description' => 'Error codes changed', 'api' => 'GetQualityProjectDetail'], + ['description' => 'Error codes changed', 'api' => 'GetQualityProjectList'], + ], + 'createdAt' => '2021-06-02T03:16:31.000Z', + 'description' => '规范openapi响应格式', ], [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateDepartment'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteDepartment'], + ['description' => 'OpenAPI offline', 'api' => 'GetAllDepartment'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateDepartment'], + ], + 'createdAt' => '2021-06-01T12:37:57.000Z', + 'description' => '部门管理api', ], [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateSkillGroup'], + ['description' => 'OpenAPI offline', 'api' => 'GetConfigNumList'], + ['description' => 'OpenAPI offline', 'api' => 'QuerySkillGroups'], + ], + 'createdAt' => '2021-05-21T09:26:07.000Z', + 'description' => 'api支持部门维度', ], [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListRobotCallDialog'], + ['description' => 'Request parameters changed', 'api' => 'RobotCall'], + ], + 'createdAt' => '2021-05-20T06:41:39.000Z', + 'description' => '调整联络中心机器人 API', ], [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QueryTouchList'], + ], + 'createdAt' => '2021-05-14T11:28:04.000Z', + 'description' => '优化QueryTouchList字段类型', ], [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QueryTouchList'], + ], + 'createdAt' => '2021-05-14T06:28:00.000Z', + 'description' => '此次发布优化了QueryTouchList的输出字段，对其调用方式并无影响。', ], [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetDepGroupTreeData'], + ['description' => 'OpenAPI offline', 'api' => 'GetQualityProjectDetail'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetQualityProjectList'], + ], + 'createdAt' => '2021-05-13T16:13:19.000Z', + 'description' => 'dev', ], [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateAgent'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteAgent'], + ['description' => 'OpenAPI offline', 'api' => 'FinishHotlineService'], + ['description' => 'OpenAPI offline', 'api' => 'GenerateWebSocketSign'], + ['description' => 'OpenAPI offline', 'api' => 'GetAgent'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentDetail'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineAgentStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetOutbounNumList'], + ['description' => 'OpenAPI offline', 'api' => 'GetRecordData'], + ['description' => 'OpenAPI offline', 'api' => 'StartHotlineService'], + ], + 'createdAt' => '2021-05-12T03:56:02.000Z', + 'description' => '规范化响应参数', ], [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'EncryptPhoneNum'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineMessageLog'], + ], + 'createdAt' => '2021-04-25T12:06:53.000Z', + 'description' => '加密 ', ], [ - 'regionId' => 'me-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetQualityProjectList'], + ], + 'createdAt' => '2021-04-08T12:44:13.000Z', + 'description' => '质检SDK 升级', ], [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineRuntimeInfo'], + ], + 'createdAt' => '2021-04-08T02:37:06.000Z', + 'description' => '刷新恢复', ], [ - 'regionId' => 'us-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetAgentBasisStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetAgentDetailReport'], + ['description' => 'OpenAPI offline', 'api' => 'GetAgentServiceStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetAgentStatistics'], + ['description' => 'OpenAPI offline', 'api' => 'GetDepartmentalLatitudeAgentStatus'], + ['description' => 'OpenAPI offline', 'api' => 'GetHotlineServiceStatistics'], + ['description' => 'OpenAPI offline', 'api' => 'GetOnlineSeatInformation'], + ['description' => 'OpenAPI offline', 'api' => 'GetOnlineServiceVolume'], + ['description' => 'OpenAPI offline', 'api' => 'GetQueueInformation'], + ['description' => 'OpenAPI offline', 'api' => 'GetSeatInformation'], + ], + 'createdAt' => '2021-04-07T12:20:13.000Z', + 'description' => '数据洞察paas端输出', ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskBizData'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopAiOutboundTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentBasisStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartChatWork'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAiOutboundTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'HangUpDoubleCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineServiceVolume'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMcuLvsIp'], + ['threshold' => '1000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepGroupTreeData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCustomerInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddHotlineNumber'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InsertAiOutboundPhoneNums'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AttachTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListChatRecordDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AiccsSmartCallOperate'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ResetHotlineNumber'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListHotlineRecordDetail'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAgentFromSkillGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineMessageLog'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListRoles'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineCallAction'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnlineSeatInformation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryHotlineNumber'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CancelAiCallDetails'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateAiOutboundTaskBatch'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskExecDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineRuntimeInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'MakeDoubleCall'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAgentStatusDetails'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentServiceStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceCapability'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteHotlineNumber'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAiCallDetailPage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartAiOutboundTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeChatAgentStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EncryptPhoneNum'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDepartmentalLatitudeAgentStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentStatistics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAllDepartment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDepartment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskList'], + ['threshold' => '400', 'countWindow' => 1, 'regionId' => '*', 'api' => 'LlmSmartCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryConversationDetailInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecordUrl'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TerminateAiOutboundTask'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateThirdSsoAgent'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupStatusTotal'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSeatInformation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRtcToken'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupAndAgentStatusSummary'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDepartment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDepartment'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAiOutboundTaskProgress'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetQueueInformation'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupLatitudeState'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSkillGroupServiceStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAgentDetailReport'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportTaskNumberDatas'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetHotlineServiceStatistics'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetConfigNumList'], ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'aiccs.aliyuncs.com', + ], + 'ram' => [ + 'productCode' => 'AICCS', + 'productName' => 'Artificial Intelligence Cloud Call Service', + 'ramCodes' => ['aiccs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetCallSoundRecord', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:GetCallSoundRecord', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:CreateTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:StartTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRobotNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotNode', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryAiVoiceAgentDetailNew', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiVoiceAgentDetailNew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'LlmFullDuplexCallOperate', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:LlmFullDuplexCallOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DescribeRecordData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:DescribeRecordData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PageQueryAgentList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:PageQueryAgentList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'HangupOperate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:HangupOperate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'LlmSmartCallEncrypt', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCallEncrypt', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'LlmSmartCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAvailableTts', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListAvailableTts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTaskDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListTaskDetail', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateAiCallTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAiCallTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ImportOneTaskPhoneNumber', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAudioNoteUploadUrl', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:GetAudioNoteUploadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateAgent', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:CreateAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'PageQueryAgentListNew', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:PageQueryAgentListNew', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AttachTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:AttachTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryConversationDetailInfoNew', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRobotCallDialog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotCallDialog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRobotParams', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListRobotParams', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StopTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:StopTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryAiVoiceAgentDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiVoiceAgentDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelAiCallDetails', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:CancelAiCallDetails', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAiccsRobot', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListAiccsRobot', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryAiCallDetailPage', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'aiccs:QueryAiCallDetailPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'SubmitAudioNote', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:SubmitAudioNote', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddLargeModel', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddLargeModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'LlmSmartCallFullDuplex', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:LlmSmartCallFullDuplex', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateLargeModel', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:UpdateLargeModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryConversationDetailInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:QueryConversationDetailInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDialog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'aiccs:ListDialog', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddModelApplication', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'aiccs:AddModelApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:CancelTask', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateModelApplication', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateModelApplication', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'TestLargeModel', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TestLargeModel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCallDialogContent', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:GetCallDialogContent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteAgent', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'aiccs:DeleteAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'resourceTypes' => [], ], ]; diff --git a/data/en_us/aiccs/2023-05-16/api-docs.php b/data/en_us/aiccs/2023-05-16/api-docs.php index e4c8433..848bd99 100644 --- a/data/en_us/aiccs/2023-05-16/api-docs.php +++ b/data/en_us/aiccs/2023-05-16/api-docs.php @@ -1,57 +1,18 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'aiccs', - 'version' => '2023-05-16', - ], + 'info' => ['style' => 'RPC', 'product' => 'aiccs', 'version' => '2023-05-16'], 'directories' => [ - 'AddBlacklist', - 'AddTask', - 'AgentCancelCall', - 'AgentRecoverCall', - 'Details', - 'EditTask', - 'ImportNumber', - 'ImportNumberV2', - 'Page', - 'SmsTemplateCreate', - 'SmsTemplatePageList', - 'TaskCallChats', - 'TaskCallInfo', - 'TaskCallList', - 'TaskCancelCall', - 'TaskList', - 'TaskRecoverCall', - 'TemplateList', - 'UpdateAgentStatus', - 'UpdateTaskCustomer', + 'AddBlacklist', 'AddTask', 'AgentCancelCall', 'AgentRecoverCall', 'Details', 'EditTask', 'ImportNumber', 'ImportNumberV2', 'Page', 'SmsTemplateCreate', 'SmsTemplatePageList', 'TaskCallChats', 'TaskCallInfo', 'TaskCallList', 'TaskCancelCall', 'TaskList', 'TaskRecoverCall', 'TemplateList', 'UpdateAgentStatus', 'UpdateTaskCustomer', 'QuickAddTask', - 'AddAgent', - 'QueryAgentInfo', - 'AddAgentGroup', - 'JoinAgentGroup', - 'QuitAgentGroup', - 'AgentGroupPage', - 'AgentCallList', - 'AgentImportNumber', - 'CallNumberDetail', - 'CallChatList', ], 'components' => [ 'schemas' => [], ], 'apis' => [ 'AddBlacklist' => [ - 'summary' => '添加黑名单接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Adds phone numbers to the blacklist for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -62,9 +23,7 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '179242', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], ], 'parameters' => [ [ @@ -72,16 +31,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '1380001****', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1380001****'], 'required' => true, 'example' => '', ], @@ -89,24 +42,12 @@ [ 'name' => 'ExpiredDay', 'in' => 'query', - 'schema' => [ - 'title' => '有效天数', - 'description' => '有效天数', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The number of days for which the blacklist entry remains valid.', 'type' => 'string', 'required' => true, 'example' => '1'], ], [ 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'required' => true, - 'example' => '示例值', - ], + 'schema' => ['title' => '', 'description' => 'The remarks.', 'type' => 'string', 'required' => true, 'example' => '备注'], ], ], 'responses' => [ @@ -114,78 +55,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机号', - 'description' => '错误手机号', + 'title' => '', + 'description' => 'The unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1380001****', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'example' => '1380001****', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The request status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful. Valid values:'."\n" + .'- true: The operation is successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"1380001****\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'AddTask' => [ - 'summary' => '创建任务接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Add blacklist numbers for industry edition', + 'description' => 'Adds phone numbers to the outbound call blocking blacklist for the industry edition.', + 'requestParamsDescription' => 'Batch blacklisting is supported, with a maximum of 5000 phone numbers per request.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddBlacklist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddBlacklist'], + ], ], + ], + 'AddTask' => [ + 'summary' => 'Creates a task for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsD1POR4'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -193,176 +131,114 @@ [ 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'title' => '任务类型', - 'description' => '任务类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The type of the task. Valid values:'."\n" + .'- 1: Batch AI outbound call without transfer to a human agent.'."\n" + .'- 2: Batch voice notification.'."\n" + .'- 6: New voice notification. This is the default voice notification type for enterprises that registered after October 2022.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => '任务名称'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '任务启动日期', - 'description' => '任务启动日期', - 'type' => 'string', - 'required' => false, - 'example' => '2022-09-16', - ], + 'schema' => ['title' => '', 'description' => 'The start date of the task.', 'type' => 'string', 'required' => false, 'example' => '2022-09-16'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype of the script template. Valid values:'."\n" + .'- 1: Single template.'."\n" + .'- 2: Intelligent script Policy Template.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID', - 'description' => '话术模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '17', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the script template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '17'], ], [ 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => '并发数', - 'description' => '并发数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '99', - ], + 'schema' => ['title' => '', 'description' => 'The number of concurrent calls. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '99'], ], [ 'name' => 'RecallType', 'in' => 'query', - 'schema' => [ - 'title' => '重呼配置', - 'description' => '重呼配置', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '53', - ], + 'schema' => ['title' => '', 'description' => 'The recall configuration. Valid values:'."\n" + .'- 1: No recall.'."\n" + .'- 2: Interval-based recall.'."\n" + .'- 3: Scheduled recall.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '53'], ], [ 'name' => 'RepeatInterval', 'in' => 'query', - 'schema' => [ - 'title' => '重呼间隔', - 'description' => '重呼间隔', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14', - ], + 'schema' => ['title' => '', 'description' => 'The recall interval. This parameter is required when RecallType is set to 2. Unit: minutes. The value must be a positive integer greater than or equal to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '14'], ], [ 'name' => 'RepeatCount', 'in' => 'query', - 'schema' => [ - 'title' => '重呼次数', - 'description' => '重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '37', - ], + 'schema' => ['title' => '', 'description' => 'The number of recall attempts. This parameter is required when RecallType is set to 2. The value must be a positive integer greater than or equal to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '37'], ], [ 'name' => 'RepeatTimes', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼时间', - 'description' => '重呼时间', + 'title' => '', + 'description' => 'The recall times.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '22:00', - ], + 'items' => ['title' => '', 'description' => 'This parameter is required when RecallType is set to 3. Format: ["8:00","9:00"]. Separate multiple time points with commas. Valid values:'."\n" + .'"7:00", "7:30", "8:00", "8:30", "9:00", "9:30", "10:00", "10:30", "11:00", "11:30", "12:00", "12:30", "13:00", "13:30", "14:00", "14:30", "15:00", "15:30", "16:00", "16:30", "17:00", "17:30", "18:00", "18:30", "19:00", "19:30", "20:00", "20:30", "21:00", "21:30", "22:00".', 'type' => 'string', 'required' => false, 'example' => '22:00'], 'required' => false, - 'example' => '', + 'example' => '示例值', ], ], [ 'name' => 'RecordPath', 'in' => 'query', - 'schema' => [ - 'title' => '录音地址', - 'description' => '录音地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], + 'schema' => ['title' => '', 'description' => 'The URL of the recording. This parameter is required when the business type enabled for the enterprise is voice notification.', 'type' => 'string', 'required' => false, 'example' => '示例值'], ], [ 'name' => 'PlaySleepVal', 'in' => 'query', - 'schema' => [ - 'title' => '播放间隔时长', - 'description' => '播放间隔时长', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '89', - ], + 'schema' => ['title' => '', 'description' => 'The playback interval. This parameter is required when the business type enabled for the enterprise is voice notification. Unit: seconds. The value must be a non-negative integer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89'], ], [ 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'title' => '录音播放次数', - 'description' => '录音播放次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], + 'schema' => ['title' => '', 'description' => 'The number of times the recording is played. This parameter is required when the business type enabled for the enterprise is voice notification. The value must be a non-negative integer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51'], ], [ 'name' => 'RepeatReason', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼条件', - 'description' => '重呼条件', + 'title' => '', + 'description' => 'The recall conditions.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => 'You can select multiple values. If this parameter is not specified, all conditions are used by default. The recall condition refers to the status of the previous outbound call, such as "Busy" or "Empty number".'."\n" + ."\n" + .'The condition codes and their descriptions are as follows:'."\n" + ."\n" + .'2: Phone off.'."\n" + .'3: Empty number.'."\n" + .'4: Number changed.'."\n" + .'5: Service suspended.'."\n" + .'6: Busy.'."\n" + .'7: Rejected.'."\n" + .'8: Unreachable.'."\n" + .'9: No answer.'."\n" + .'10: Overdue payment.'."\n" + .'11: Line fault.'."\n" + .'12: Call failed.'."\n" + .'30: Blocked.'."\n" + .'40: Daily call limit reached.', 'type' => 'string', 'required' => false, 'example' => '2'], 'required' => false, 'example' => '', ], @@ -372,29 +248,29 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', + 'title' => '', + 'description' => 'The outbound call time. Format example: for "8:30-12:00 13:30-19:00", pass [[8.5,12][13.5,19]]. Default value: [[8,20]].', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The outbound call time. Format example: for "8:30-12:00 13:30-19:00", pass [[8.5,12][13.5,19]]. Default value: [[8,20]].', 'type' => 'object', 'properties' => [ 'CallTime' => [ - 'description' => '', + 'title' => '', + 'description' => 'The outbound call time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '12:30', - ], + 'items' => ['title' => '', 'description' => 'The outbound call time, for example, 8.5.', 'type' => 'string', 'required' => false, 'example' => '8.5'], 'required' => false, 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => false, - 'example' => '', + 'enumValueTitles' => [], + 'example' => '14', ], ], [ @@ -402,35 +278,26 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '短信发送规则', - 'description' => '短信发送规则', + 'title' => '', + 'description' => 'The SMS sending rule.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The SMS sending rule.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent labels.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'A', - ], + 'items' => ['title' => '', 'description' => 'The matched intent labels in uppercase, for example, ["A", "B"]. An SMS message is triggered if any condition is met.', 'type' => 'string', 'required' => false, 'example' => 'A'], 'required' => false, 'example' => '', ], - 'SmsTemplateId' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '71', - ], + 'SmsTemplateId' => ['title' => '', 'description' => 'The ID of the SMS template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '71'], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -439,109 +306,118 @@ [ 'name' => 'CallbackUrl', 'in' => 'query', - 'schema' => [ - 'title' => '回调地址', - 'description' => '回调地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The callback URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'FlashSmsType', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS configuration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => ''], + ], + [ + 'name' => 'FlashSmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the flash SMS template. This parameter is required when FlashSmsType is set to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '96', 'default' => ''], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '发送闪信配置', - 'description' => '发送闪信配置', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The outbound call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, for 08:31-12:05 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The outbound call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, for 08:31-12:05 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The first call time string.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The first call time string.', 'type' => 'string', 'required' => false, 'example' => '"08:31"'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => '0', - 'default' => '', + 'example' => '', ], ], [ - 'name' => 'FlashSmsTemplateId', + 'name' => 'WeekTag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当发送闪信配置为1时，闪信模板ID必填', - 'description' => '当发送闪信配置为1时，闪信模板ID必填', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The days of the week on which outbound calls are made. For example, [1,2,3,4,5,6,7] indicates that outbound calls are made from Monday to Sunday.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Wednesday.', 'type' => 'string', 'required' => false, 'example' => '3'], 'required' => false, - 'example' => '96', - 'default' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'AccessDeniedDetail', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912', - ], + 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details about the access denial.', 'type' => 'string', 'example' => 'None'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '成功'], + 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912'], 'Model' => [ - 'description' => '', + 'title' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '47', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '47'], ], 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686225227338', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Timestamp' => ['title' => '', 'description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686225227338'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'false'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 47\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'Create task - industry edition', + 'description' => 'Creates a task for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 47\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": false\\n}","type":"json"}]', ], 'AgentCancelCall' => [ - 'summary' => '坐席取消号码外呼', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Cancels an outbound call by an agent in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -554,9 +430,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179248', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -564,40 +438,22 @@ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '64', - ], + 'schema' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '64'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The agent tag.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13314206082', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13314206082', 'title' => ''], 'required' => false, 'example' => '', ], @@ -607,15 +463,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of user-defined tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -626,70 +477,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13100000000', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13100000000', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13100000000\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Cancel outbound call by agent in industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentCancelCall'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13100000000\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', ], 'AgentRecoverCall' => [ - 'summary' => '坐席任务恢复号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Restores the numbers that were canceled for outbound calls by an agent to the pending outbound call status and initiates outbound calls.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -702,9 +545,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179246', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -712,40 +553,22 @@ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['title' => '', 'description' => 'The tag of the agent.', 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of user-defined tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -755,15 +578,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13541251222,18665214444', 'title' => ''], 'required' => false, 'example' => '', ], @@ -771,26 +589,12 @@ [ 'name' => 'BeginImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始导入时间', - 'description' => '查询开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => ' 2020-03-06 10:10:10', - 'default' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => ' 2020-03-06 10:10:10', 'default' => '"2023-01-09 18:58:19"'], ], [ 'name' => 'EndImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束导入时间', - 'description' => '查询结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => ' 2021-03-06 10:10:10', - 'default' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => ' 2021-03-06 10:10:10', 'default' => '"2023-01-09 18:58:19"'], ], ], 'responses' => [ @@ -798,71 +602,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13314206082', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13314206082', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The error code. A value of 0 indicates success.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'string', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13314206082\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'Details' => [ - 'summary' => 'AI批量任务查询号码状态接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Industry edition - resume agent outbound calls', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentRecoverCall'], + ], ], + ], + 'Details' => [ + 'summary' => 'Queries the number status of an AI batch task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -870,74 +665,37 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '90', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '90'], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '开始导入时间', - 'description' => '开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-25 15:19:02', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-04-25 15:19:02'], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => '结束导入时间', - 'description' => '结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-25 15:19:02', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-04-25 15:19:02'], ], [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'title' => '批次id', - 'description' => '批次id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '75', - ], + 'schema' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '75'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222', - ], + 'items' => ['description' => 'The phone number to query. Batch queries are supported, with a maximum of 1000 numbers.', 'type' => 'string', 'required' => false, 'example' => '13541251222', 'title' => ''], 'required' => false, 'example' => '', ], @@ -945,38 +703,20 @@ [ 'name' => 'NumberStatus', 'in' => 'query', - 'schema' => [ - 'title' => '号码状态', - 'description' => '号码状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The number status to query. Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '77', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '77'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页条数', - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '3', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'], ], ], 'responses' => [ @@ -984,188 +724,200 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '389b2d0a-37e2-406d-b576-1fc0827be46a', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '389b2d0a-37e2-406d-b576-1fc0827be46a', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The model.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'number', - 'format' => 'float', - 'example' => '71.8132', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '79', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '94', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28', - ], - 'BatchId' => [ - 'title' => '批次号', - 'description' => '批次号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27', - ], - 'CallDesc' => [ - 'title' => '呼叫状态描述', - 'description' => '呼叫状态描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '28dd74a4-30ec-43c0-9bec-272924c51eeb', - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2001', - ], - 'CallStatus' => [ - 'title' => '呼叫状态', - 'description' => '呼叫状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ImportTime' => [ - 'title' => '导入时间', - 'description' => '导入时间', - 'type' => 'string', - 'example' => '2023-04-25 15:19:02', - ], - 'NumberDesc' => [ - 'title' => '号码状态描述', - 'description' => '号码状态描述', - 'type' => 'string', - 'example' => '示例值', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '188******454', - ], - 'InterceptReason' => [ - 'title' => '拦截原因', - 'description' => '拦截原因', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'NumberStatus' => [ - 'title' => '号码状态', - 'description' => '号码状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => 'A', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => 'cbe1b40f76f2cca4735954886b706ffa', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '28'], + 'BatchId' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '27'], + 'CallDesc' => ['title' => '', 'description' => 'The call status description, such as "Answered" or "Rejected".'."\n" + .'When the number status is 1 (failed to call), valid values:'."\n" + .'-516: outbound number concurrency limit.'."\n" + .'-515: number frequency limit.'."\n" + .'-514: no line configured.'."\n" + .'-513: concurrency limit.'."\n" + .'-512: outside calling hours.'."\n" + .'-511: blocked area code.'."\n" + .'-310: waiting for distribution.'."\n" + .'-210: call canceled (repayment query failed).'."\n" + .'-110: call canceled (repayment completed).'."\n" + .'-20: agent offline.'."\n" + .'-19: agent did not answer.'."\n" + .'-18: failed to call agent.'."\n" + .'-17: call canceled.'."\n" + .'-16: call timed out.'."\n" + .'-15: failed to obtain voice gateway information.'."\n" + .'-14: failed to convert MD5 to phone number.'."\n" + .'-13: failed to pre-cache audio file.'."\n" + .'When the number status is 2 (call in progress), valid values:'."\n" + .'-12: pre-caching audio file.'."\n" + .'-11: waiting to pre-cache audio file.'."\n" + .'-10: not started.'."\n" + .'-9: waiting to call.'."\n" + .'-8: calling.'."\n" + .'-7: AI call in progress.'."\n" + .'-6: assigning agent.'."\n" + .'-5: manual call in progress.'."\n" + .'-4: monitoring ringing.'."\n" + .'-3: monitoring failed.'."\n" + .'-2: monitoring.'."\n" + .'When the number status is 3 (call completed), valid values:'."\n" + .'1: answered.'."\n" + .'2: powered off.'."\n" + .'3: invalid number.'."\n" + .'4: number changed.'."\n" + .'5: out of service.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: missed.'."\n" + .'10: overdue payment.'."\n" + .'11: line failure.'."\n" + .'12: call failed.'."\n" + .'30: intercepted. '."\n" + .'40: daily call limit reached.', 'type' => 'string', 'example' => '已接听'], + 'CallId' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'example' => '28dd74a4-30ec-43c0-9bec-272924c51eeb'], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + .'2001: batch - predictive outbound call.'."\n" + .'2002: batch - AI outbound call - no transfer to agent.'."\n" + .'2003: batch - AI outbound call - transfer to agent on answer.'."\n" + .'2004: batch - AI outbound call - intelligent transfer to agent.'."\n" + .'2005: batch - voice notification.', 'type' => 'integer', 'format' => 'int64', 'example' => '2001'], + 'CallStatus' => ['title' => '', 'description' => 'The call status code.'."\n" + .'When the number status is 1 (failed to call), valid values:'."\n" + .'-516: outbound number concurrency limit.'."\n" + .'-515: number frequency limit.'."\n" + .'-514: no line configured.'."\n" + .'-513: concurrency limit.'."\n" + .'-512: outside calling hours.'."\n" + .'-511: blocked area code.'."\n" + .'-310: waiting for distribution.'."\n" + .'-210: call canceled (repayment query failed).'."\n" + .'-110: call canceled (repayment completed).'."\n" + .'-20: agent offline.'."\n" + .'-19: agent did not answer.'."\n" + .'-18: failed to call agent.'."\n" + .'-17: call canceled.'."\n" + .'-16: call timed out.'."\n" + .'-15: failed to obtain voice gateway information.'."\n" + .'-14: failed to convert MD5 to phone number.'."\n" + .'-13: failed to pre-cache audio file.'."\n" + .'When the number status is 2 (call in progress), valid values:'."\n" + .'-12: pre-caching audio file.'."\n" + .'-11: waiting to pre-cache audio file.'."\n" + .'-10: not started.'."\n" + .'-9: waiting to call.'."\n" + .'-8: calling.'."\n" + .'-7: AI call in progress.'."\n" + .'-6: assigning agent.'."\n" + .'-5: manual call in progress.'."\n" + .'-4: monitoring ringing.'."\n" + .'-3: monitoring failed.'."\n" + .'-2: monitoring.'."\n" + .'When the number status is 3 (call completed), valid values:'."\n" + .'1: answered.'."\n" + .'2: powered off.'."\n" + .'3: invalid number.'."\n" + .'4: number changed.'."\n" + .'5: out of service.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: missed.'."\n" + .'10: overdue payment.'."\n" + .'11: line failure.'."\n" + .'12: call failed.'."\n" + .'30: intercepted. '."\n" + .'40: daily call limit reached.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The import time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-25 15:19:02'], + 'NumberDesc' => ['title' => '', 'description' => 'The number status description, such as "Failed to call". Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'string', 'example' => '未能外呼'], + 'Number' => ['title' => '', 'description' => 'The outbound call number.', 'type' => 'string', 'example' => '188******454'], + 'InterceptReason' => ['title' => '', 'description' => 'The interception reason. When the status is intercepted, valid values: blacklist interception, graylist interception, or abnormal number interception.', 'type' => 'string', 'example' => '黑名单拦截'], + 'NumberStatus' => ['title' => '', 'description' => 'The number status. Valid values:'."\n" + .'1: failed to call.'."\n" + .'2: call in progress.'."\n" + .'3: call completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Tag' => ['title' => '', 'description' => 'The user-defined tag.', 'type' => 'string', 'example' => 'A'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the outbound call number.', 'type' => 'string', 'example' => 'cbe1b40f76f2cca4735954886b706ffa'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686279332221', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686279332221', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"389b2d0a-37e2-406d-b576-1fc0827be46a\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 79,\\n \\"PageSize\\": 94,\\n \\"TotalPage\\": 10,\\n \\"PageNo\\": 100,\\n \\"List\\": [\\n {\\n \\"TaskId\\": 28,\\n \\"BatchId\\": 27,\\n \\"CallDesc\\": \\"已接听\\",\\n \\"CallId\\": \\"28dd74a4-30ec-43c0-9bec-272924c51eeb\\",\\n \\"CallType\\": 2001,\\n \\"CallStatus\\": 1,\\n \\"ImportTime\\": \\"2023-04-25 15:19:02\\",\\n \\"NumberDesc\\": \\"未能外呼\\",\\n \\"Number\\": \\"188******454\\",\\n \\"InterceptReason\\": \\"黑名单拦截\\",\\n \\"NumberStatus\\": 1,\\n \\"Tag\\": \\"A\\",\\n \\"NumberMD5\\": \\"cbe1b40f76f2cca4735954886b706ffa\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686279332221,\\n \\"Success\\": false\\n}","type":"json"}]', - ], - 'EditTask' => [ - 'summary' => '编辑任务接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Query number status of an AI batch task (industry edition)', + 'description' => 'Queries the number status of an AI batch task.', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Details', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Details'], + ], ], + ], + 'EditTask' => [ + 'summary' => 'Edits a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1173,111 +925,86 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '29', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '29'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task status. Modifies the task status. Valid values:'."\n" + .'- 2: started.'."\n" + .'- 4: stopped.'."\n" + ."\n" + .'If this parameter is not specified, the task status is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The task name. Modifies the task name. The name cannot exceed 100 characters.'."\n" + ."\n" + .'If this parameter is not specified, the task name is not modified.', 'type' => 'string', 'required' => false, 'example' => '任务名称'."\n" + ."\n"], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The script templatetype. Valid values:'."\n" + .'- 1: single-model template.'."\n" + .'- 2: intelligent script Policy Template.'."\n" + ."\n" + .'If you do not pass parameter, the templatetype is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID', - 'description' => '话术模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['title' => '', 'description' => 'The script template ID.'."\n" + ."\n" + .'If this parameter is not specified, the template ID is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], ], [ 'name' => 'MaxConcurrency', 'in' => 'query', - 'schema' => [ - 'title' => '并发数', - 'description' => '并发数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '83', - ], + 'schema' => ['title' => '', 'description' => 'The concurrency. Modifies the concurrency. Default value: 1. The value cannot exceed the maximum concurrency configured for the enterprise.'."\n" + ."\n" + .'If this parameter is not specified, the concurrency is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '83'], ], [ 'name' => 'RecallType', 'in' => 'query', - 'schema' => [ - 'title' => '重呼配置', - 'description' => '重呼配置', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The recall configuration. Valid values:'."\n" + .'- 1: no recall. This is the default value.'."\n" + .'- 2: interval-based recall.'."\n" + .'- 3: scheduled recall.'."\n" + ."\n" + .'If this parameter is not specified, the recall configuration is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], [ 'name' => 'CallTimeList', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', + 'title' => '', + 'description' => 'The call time. For example, to specify 8:30-12:00 and 13:30-19:00, pass [[8.5,12][13.5,19]].'."\n" + ."\n" + .'If this parameter is not specified, the call time is not modified.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The call time. For example, to specify 8:30-12:00 and 13:30-19:00, pass [[8.5,12][13.5,19]].'."\n" + ."\n" + .'If this parameter is not specified, the call time is not modified.', 'type' => 'object', 'properties' => [ 'CallTime' => [ - 'description' => '', + 'title' => '', + 'description' => 'The call time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8.5', - ], + 'items' => ['title' => '', 'description' => 'The call time.', 'type' => 'string', 'required' => false, 'example' => '8.5'], 'required' => false, 'example' => '', ], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -1286,41 +1013,29 @@ [ 'name' => 'RepeatInterval', 'in' => 'query', - 'schema' => [ - 'title' => '重呼间隔', - 'description' => '重呼间隔', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '91', - ], + 'schema' => ['title' => '', 'description' => 'The recall interval. Required when the recall option is set to 2. Unit: minutes. The value must be a positive integer greater than or equal to 1.'."\n" + ."\n" + .'If this parameter is not specified, the recall interval is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '91'], ], [ 'name' => 'RepeatCount', 'in' => 'query', - 'schema' => [ - 'title' => '重呼次数', - 'description' => '重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], + 'schema' => ['title' => '', 'description' => 'The recall count. Required when the recall option is set to 2. The value must be a positive integer greater than or equal to 1.'."\n" + ."\n" + .'If this parameter is not specified, the recall count is not modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '51'], ], [ 'name' => 'RepeatTimes', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼时间', - 'description' => '重呼时间', + 'title' => '', + 'description' => 'The recall time.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8:30', - ], + 'items' => ['title' => '', 'description' => 'Required when the recall option is set to 3. Format: ["8:00","9:00"]. Separate multiple time points with commas. Valid values:'."\n" + .'"7:00", "7:30", "8:00", "8:30", "9:00", "9:30", "10:00", "10:30", "11:00", "11:30", "12:00", "12:30", "13:00", "13:30", "14:00", "14:30", "15:00", "15:30", "16:00", "16:30", "17:00", "17:30", "18:00", "18:30", "19:00", "19:30", "20:00", "20:30", "21:00", "21:30", "22:00"'."\n" + ."\n" + .'If this parameter is not specified, the recall time is not modified.', 'type' => 'string', 'required' => false, 'example' => '8:30'], 'required' => false, 'example' => '', ], @@ -1328,72 +1043,43 @@ [ 'name' => 'RecordPath', 'in' => 'query', - 'schema' => [ - 'title' => '录音地址', - 'description' => '录音地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The recording URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'PlaySleepVal', 'in' => 'query', - 'schema' => [ - 'title' => '播放间隔时长', - 'description' => '播放间隔时长', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '29', - ], + 'schema' => ['title' => '', 'description' => 'The playback interval duration.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '29'], ], [ 'name' => 'PlayTimes', 'in' => 'query', - 'schema' => [ - 'title' => '录音播放次数', - 'description' => '录音播放次数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], + 'schema' => ['title' => '', 'description' => 'The recording playback count.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60'], ], [ 'name' => 'SendSmsPlan', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '短信发送规则', - 'description' => '短信发送规则', + 'title' => '', + 'description' => 'The SMS sending rule. Specifies the rule for sending post-hangup SMS messages. If this parameter is empty, no SMS messages are sent.', 'type' => 'array', 'items' => [ + 'title' => '', + 'description' => 'The SMS sending rule. Specifies the rule for sending post-hangup SMS messages. If this parameter is empty, no SMS messages are sent.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent labels.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'A', - ], + 'items' => ['title' => '', 'description' => 'The array of intent labels in uppercase. Example: ["A", "B"].', 'type' => 'string', 'required' => false, 'example' => 'A'], 'required' => false, 'example' => '', ], - 'SmsTemplateId' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'SmsTemplateId' => ['title' => '', 'description' => 'The SMS template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], 'required' => false, + 'example' => '', ], 'required' => false, 'example' => '', @@ -1404,16 +1090,26 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '重呼条件', - 'description' => '重呼条件', + 'title' => '', + 'description' => 'The recall condition.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'items' => ['title' => '', 'description' => 'Multiple values can be selected. If this parameter is not specified, the default conditions are [2, 3, 4, 5, 6, 8, 9, 10, 11, 12]. The recall condition refers to the status of the previous outbound call, such as "busy" or "empty number".'."\n" + ."\n" + .'The recall condition codes and their descriptions are as follows:'."\n" + ."\n" + .'2: powered off.'."\n" + .'3: empty number.'."\n" + .'4: number changed.'."\n" + .'5: suspended.'."\n" + .'6: busy.'."\n" + .'7: rejected.'."\n" + .'8: unreachable.'."\n" + .'9: unanswered.'."\n" + .'10: overdue payment.'."\n" + .'11: line fault.'."\n" + .'12: call failed.'."\n" + .'30: intercepted.'."\n" + .'40: daily call limit reached.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], 'required' => false, 'example' => '', ], @@ -1421,110 +1117,120 @@ [ 'name' => 'CallbackUrl', 'in' => 'query', - 'schema' => [ - 'title' => '回调地址', - 'description' => '回调地址', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The callback URL.', 'type' => 'string', 'required' => false, 'example' => '示例值示例值示例值'], ], [ 'name' => 'FlashSmsType', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS configuration. Default value: 0. Valid values:'."\n" + .'- 0: do not send flash SMS.'."\n" + .'- 1: send flash SMS.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'default' => ''], + ], + [ + 'name' => 'FlashSmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The flash SMS template ID. Required when the flash SMS configuration is set to 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'default' => ''], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '发送闪信配置,默认为0,0不发送闪信.1发送闪信', - 'description' => '发送闪信配置,默认为0,0不发送闪信.1发送闪信', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The call time with minute-level precision. If both this parameter and CallTimeList are specified, this parameter takes precedence. Use this parameter for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The first call time string.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The first call time string.', 'type' => 'string', 'required' => false, 'example' => '"08:00"'], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], 'required' => false, - 'example' => '0', - 'default' => '', + 'example' => '', ], ], [ - 'name' => 'FlashSmsTemplateId', + 'name' => 'WeekTag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '当发送闪信配置为1时，闪信模板ID必填', - 'description' => '当发送闪信配置为1时，闪信模板ID必填', - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The days of the week for outbound calls. Example: [1,2,3,4,5,6,7], which indicates outbound calls from Monday to Sunday.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'Wednesday.', 'type' => 'string', 'required' => false, 'example' => '3'], 'required' => false, - 'example' => '60', - 'default' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912', - ], + 'AccessDeniedDetail' => ['title' => '', 'description' => 'The details of the access denial.', 'type' => 'string', 'example' => 'None'], + 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => '成功'], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '5453cc9b-02bc-4dbb-9527-f28a9100b912'], 'Model' => [ - 'description' => '', + 'title' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '92', - ], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '92'], ], 'example' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686225227338', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'Timestamp' => ['title' => '', 'description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1686225227338'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true'], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 92\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Industry edition - edit task', + 'description' => 'Edits a task in the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditTask'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:EditTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"5453cc9b-02bc-4dbb-9527-f28a9100b912\\",\\n \\"Model\\": {\\n \\"TaskId\\": 92\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1686225227338,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'ImportNumber' => [ - 'summary' => '导入号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Imports task phone numbers in batches for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1537,9 +1243,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179241', - 'abilityTreeNodes' => [ - 'FEATUREaiccsDTMAFT', - ], + 'abilityTreeNodes' => ['FEATUREaiccsDTMAFT'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1547,81 +1251,47 @@ [ 'name' => 'OutId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['description' => 'The external ID used for idempotency control.', 'type' => 'string', 'required' => true, 'example' => '示例值示例值', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '92', - ], + 'schema' => ['description' => 'The task ID. This must be determined in advance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '92', 'title' => ''], ], [ 'name' => 'Customers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The outbound call customers, including specific user information such as phone numbers and names. A maximum of 1000 customers can be specified.', 'type' => 'array', 'items' => [ 'description' => 'map', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], - 'ClientUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'http://test.com', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'NumberMD5' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '{"testt":"123"}', - ], + 'Number' => ['description' => 'The plaintext phone number. You must specify either NumberMD5 or Number.', 'type' => 'string', 'required' => false, 'example' => '13541251222', 'title' => ''], + 'ClientUrl' => ['description' => 'The client pop-up URL. This is a special field.', 'type' => 'string', 'required' => false, 'example' => 'http://test.com', 'title' => ''], + 'Tag' => ['description' => 'The user-defined tag.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], + 'NumberMD5' => ['description' => 'The MD5 hash of the phone number. You must specify either NumberMD5 or Number.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], + 'Properties' => ['description' => 'The properties that must be specified based on the specific task parameter requirements. The total length is limited to 500 characters. Excess characters are truncated.', 'type' => 'object', 'required' => false, 'example' => '{"testt":"123"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'example' => '', + 'example' => '92', + 'title' => '', ], ], [ 'name' => 'FailReturn', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'Valid values:'."\n" + .'- 0: imports the data that passes validation and returns the data that fails validation.'."\n" + .'- 1: does not import any data, including data that passes and fails validation.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -1629,88 +1299,61 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'AccessDeniedDetail' => ['description' => 'The details about the access denial. This field is returned only when RAM authentication fails.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'ImportNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '54', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '94', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '状态描述', 'title' => ''], + 'ImportNum' => ['description' => 'The number of imported records.', 'type' => 'integer', 'format' => 'int64', 'example' => '26', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54', 'title' => ''], + 'Data' => ['description' => 'The fault information.', 'type' => 'string', 'example' => '示例', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '非必填 可能没有值', 'title' => ''], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"Message\\": \\"状态描述\\",\\n \\"ImportNum\\": 26,\\n \\"BatchId\\": 54,\\n \\"Data\\": \\"示例\\",\\n \\"Code\\": 0\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'ImportNumberV2' => [ - 'summary' => '导入号码', - 'methods' => [ - 'post', + 'title' => 'Import task phone numbers in batches for the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:ImportNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportNumber'], + ], ], + ], + 'ImportNumberV2' => [ + 'summary' => 'Imports task phone numbers in batches for the industry edition with an increased import quantity limit.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -1723,9 +1366,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '262750', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1733,82 +1374,47 @@ [ 'name' => 'OutId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值', - ], + 'schema' => ['description' => 'Required. The external transaction ID.', 'type' => 'string', 'required' => false, 'example' => '示例值', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92', - ], + 'schema' => ['description' => 'Required. The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '89', 'title' => ''], ], [ 'name' => 'Customers', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Required. The information about the outbound call customers, such as phone numbers and names. A maximum of 1000 entries are allowed.', 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'ClientUrl' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'Tag' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'NumberMD5' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '示例值示例值', - ], - 'Properties' => [ - 'description' => '', - 'type' => 'object', - 'required' => false, - 'example' => '', - ], + 'Number' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13800138000', 'title' => ''], + 'ClientUrl' => ['description' => 'The client pop-up URL. This is a special field.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx', 'title' => ''], + 'Tag' => ['description' => 'The tag.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'NumberMD5' => ['description' => 'The encrypted phone number. Either this parameter or the Number parameter must be specified.', 'type' => 'string', 'required' => false, 'example' => 'frgwryh5q4y623532542', 'title' => ''], + 'Properties' => ['description' => 'The parameters. These must be agreed upon in advance.', 'type' => 'object', 'required' => false, 'example' => '{"testt":"123"}', 'title' => ''], ], 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, 'example' => '', + 'title' => '', ], ], [ 'name' => 'FailReturn', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Valid values:'."\n" + .'- 0: imports the data that passes validation and returns the data that fails validation.'."\n" + .'- 1: does not import any data (including data that passes and fails validation) if some data fails validation.'."\n" + ."\n" + .'Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -1816,90 +1422,50 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'ImportNum' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '58', - ], - 'BatchId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], + 'ImportNum' => ['description' => 'The number of successfully imported entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '当前批次导入成功的数量', 'title' => ''], + 'BatchId' => ['description' => 'The batch ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '导入号码时返回的批次号', 'title' => ''], + 'Data' => ['description' => 'The fault error message.', 'type' => 'string', 'example' => '如failReturn传0，则返回该字段，可以为空；如为1，不返回。例：[{"number":"外呼号码为空或错误. 错误值:185207857231","尊称":"尊称错误,请传入中文。错误值：abc","还款金额":"值错误,请传入数字。错误值：a219.33","逾期天数":"值错误,请传入数字。错误值：今天中午十一点之前"}]}', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'title' => '', + ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '98', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"成功\\\\n\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"Message\\": \\"示例值示例值示例值\\",\\n \\"ImportNum\\": 0,\\n \\"BatchId\\": 0,\\n \\"Data\\": \\"如failReturn传0，则返回该字段，可以为空；如为1，不返回。例：[{\\\\\\"number\\\\\\":\\\\\\"外呼号码为空或错误. 错误值:185207857231\\\\\\",\\\\\\"尊称\\\\\\":\\\\\\"尊称错误,请传入中文。错误值：abc\\\\\\",\\\\\\"还款金额\\\\\\":\\\\\\"值错误,请传入数字。错误值：a219.33\\\\\\",\\\\\\"逾期天数\\\\\\":\\\\\\"值错误,请传入数字。错误值：今天中午十一点之前\\\\\\"}]}\\",\\n \\"Code\\": 200\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 98,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'Page' => [ - 'summary' => '查询企业黑名单', - 'methods' => [ - 'post', - 'get', + 'title' => 'Import task phone numbers in batches (industry edition V2)', + 'changeSet' => [ + ['createdAt' => '2025-05-13T14:41:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'Page' => [ + 'summary' => 'Query Industry Edition blocklist.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -1912,9 +1478,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '179243', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -1924,39 +1488,23 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'Number list.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '15823099196', - ], + 'items' => ['description' => 'Mobile phone number.', 'type' => 'string', 'required' => false, 'example' => '15823099196', 'title' => ''], 'required' => false, 'example' => '', + 'title' => '', ], ], [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page in a paginated query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -1964,124 +1512,233 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The status code description.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '97', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '97', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The details list.', 'type' => 'array', 'items' => [ 'description' => 'map', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'title' => '手机号码', - 'description' => '手机号码', - 'type' => 'string', - 'example' => '13314206082', - ], - 'CreateTime' => [ - 'title' => '添加时间', - 'description' => '添加时间', - 'type' => 'string', - 'example' => ' 2020-03-06 10:10:10', - ], - 'NumberMD5' => [ - 'title' => '手机号MD5', - 'description' => '手机号MD5', - 'type' => 'string', - 'example' => 'e10adc3949ba59abbe56e057f20f883e', - ], - 'ExpirationTime' => [ - 'title' => '过期时间', - 'description' => '过期时间', - 'type' => 'string', - 'example' => '1', - ], - 'Remark' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'example' => '示例值', - ], + 'Number' => ['title' => '', 'description' => 'The mobile phone number.', 'type' => 'string', 'example' => '13314206082'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the entry was created.', 'type' => 'string', 'example' => ' 2020-03-06 10:10:10'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the mobile phone number.', 'type' => 'string', 'example' => 'e10adc3949ba59abbe56e057f20f883e'], + 'ExpirationTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '1'], + 'Remark' => ['title' => '', 'description' => 'The remark.', 'type' => 'string', 'example' => '备注'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', + 'Code' => ['description' => 'The status code. A return value of 0 indicates a successful request.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 97,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 5,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"13314206082\\",\\n \\"CreateTime\\": \\" 2020-03-06 10:10:10\\",\\n \\"NumberMD5\\": \\"e10adc3949ba59abbe56e057f20f883e\\",\\n \\"ExpirationTime\\": \\"1\\",\\n \\"Remark\\": \\"备注\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Industry Edition - Paginated blocklist query', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Page', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Page'], + ], + ], + ], + 'QuickAddTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREaiccsDTMAFT'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => 'a'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start date of the task.', 'type' => 'string', 'required' => false, 'example' => '2019-04-30'], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The script templatetype. If not specified, the default value is 1. Valid values:'."\n" + ."\n" + .'- 1: single template.'."\n" + .'- 2: intelligent script policy template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'TemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the script template. If not specified, the script template of the copied task is used.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'SmsTemplateId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the SMS template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ReferenceTaskId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the task to be copied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'AgentGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the agent group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'CallTimeList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'title' => '', + 'description' => 'The outbound call time.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The outbound call time.', 'type' => 'string', 'required' => false, 'example' => '8.5'], + 'required' => false, + 'example' => '', + ], ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CallTimeStrList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The outbound call time, accurate to the minute. If both fields have values, this field takes precedence. Use this field for minute-level precision. For example, to specify 08:31-12:05 and 13:33-19:00, pass [["08:31","12:05"]["13:33","19:00"]]. Default value: [["08:00","20:00"]].', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CallTime' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'required' => false, 'example' => '"08:00"', 'description' => '', 'title' => ''], + 'required' => false, + 'example' => '["08:00","20:00"]', + 'description' => '', + 'title' => '', + ], ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', + 'required' => false, + 'example' => 'CallTimeStrList', + 'description' => '', + 'title' => '', + ], + 'required' => false, + 'example' => '[["08:31","12:05"]["13:33","19:00"]]；默认为[["08:00","20:00"]]', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => ['description' => 'The detailed reason why access was denied.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. This ID uniquely identifies the request. If an issue occurs, use the RequestId to locate the relevant records for troubleshooting.', 'type' => 'string', 'example' => 'example', 'title' => ''], + 'Model' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'example' => '', + 'title' => '', ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '77', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Industry edition - quick task creation', + 'summary' => 'Quickly creates a task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 97,\\n \\"PageSize\\": 20,\\n \\"TotalPage\\": 5,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"Number\\": \\"13314206082\\",\\n \\"CreateTime\\": \\" 2020-03-06 10:10:10\\",\\n \\"NumberMD5\\": \\"e10adc3949ba59abbe56e057f20f883e\\",\\n \\"ExpirationTime\\": \\"1\\",\\n \\"Remark\\": \\"备注\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 77,\\n \\"Success\\": true\\n}","type":"json"}]', ], 'SmsTemplateCreate' => [ - 'summary' => '短信模板创建', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Adds an SMS template for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2094,9 +1751,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180596', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -2104,59 +1759,30 @@ [ 'name' => 'TemplateName', 'in' => 'query', - 'schema' => [ - 'title' => '模板名称', - 'description' => '模板名称', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The name of the template.', 'type' => 'string', 'required' => true, 'example' => '模板'], ], [ 'name' => 'Sign', 'in' => 'query', - 'schema' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'required' => true, - 'example' => 'ef2i29fsljf', - ], + 'schema' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'required' => true, 'example' => 'ef2i29fsljf'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '56', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '模板类型，默认为1'."\n" + .'1：普通短信模板'], ], [ 'name' => 'Content', 'in' => 'query', - 'schema' => [ - 'title' => '短信内容', - 'description' => '短信内容', - 'type' => 'string', - 'required' => true, - 'example' => '示例值示例值示例值', - ], + 'schema' => ['title' => '', 'description' => 'The content of the SMS message.', 'type' => 'string', 'required' => true, 'example' => '短信内容，可增加变量，变量格式：{变量}，需系统存在'], ], [ 'name' => 'SmsType', 'in' => 'query', - 'schema' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '73', - ], + 'schema' => ['title' => '', 'description' => 'The type of the SMS message.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '短信类型，默认为3'."\n" + .'3：挂机短信'."\n" + .'4：群发短信'], ], ], 'responses' => [ @@ -2164,57 +1790,49 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], - 'Model' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '23', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to trace the cause of an error.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": \\"成功\\",\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Add an SMS template for the industry edition', + 'description' => 'Creates an SMS template for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplateCreate'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplateCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'SmsTemplatePageList' => [ - 'summary' => '短信模板列表查询', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries the list of SMS templates for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2225,93 +1843,51 @@ 'systemTags' => [ 'operationType' => 'none', 'abilityTreeCode' => '180597', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], ], 'parameters' => [ [ 'name' => 'PageNo', 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => '页码', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '24', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '24'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页条数', - 'description' => '每页条数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '97', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '97'], ], [ 'name' => 'TemplateType', 'in' => 'query', - 'schema' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '19', - ], + 'schema' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需查询的模板类型'."\n" + .'1：普通短信模板'."\n" + .'2：智能短链模板'], ], [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '模板ID', - 'description' => '模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '83', - ], + 'schema' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '83'], ], [ 'name' => 'SmsType', 'in' => 'query', - 'schema' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '42', - ], + 'schema' => ['title' => '', 'description' => 'The SMS type.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需要查询的短信类型'."\n" + .'3：挂机短信'."\n" + .'4：群发短信'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '模板状态', - 'description' => '模板状态', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '92', - ], + 'schema' => ['title' => '', 'description' => 'The template status.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '需要查询的模板状态'."\n" + .'1：待审核'."\n" + .'2：审核中'."\n" + .'3：审核不通过'."\n" + .'4：可应用'], ], [ 'name' => 'Sign', 'in' => 'query', - 'schema' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'required' => false, - 'example' => '114ah23m', - ], + 'schema' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'required' => false, 'example' => '114ah23m'], ], ], 'responses' => [ @@ -2319,155 +1895,88 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '42', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '31', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '53', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '42', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '31', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '53', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '模板状态', - 'description' => '模板状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'SmsType' => [ - 'title' => '短信类型', - 'description' => '短信类型', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Content' => [ - 'title' => '短信内容', - 'description' => '短信内容', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2021-09-26 11:34:59', - ], - 'TemplateName' => [ - 'title' => '模板名称', - 'description' => '模板名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Sign' => [ - 'title' => '短信签名', - 'description' => '短信签名', - 'type' => 'string', - 'example' => 'a234n', - ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '56', - ], - 'Properties' => [ - 'title' => '模板所需参数', - 'description' => '模板所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TemplateId' => [ - 'title' => '模板ID', - 'description' => '模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '67', - ], - 'ShortUrlTaskId' => [ - 'title' => '智能短链ID', - 'description' => '智能短链ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '46', - ], + 'Status' => ['title' => '', 'description' => 'The template status.', 'type' => 'integer', 'format' => 'int64', 'example' => '1：待审核'."\n" + .'2：审核中'."\n" + .'3：审核不通过'."\n" + .'4：可应用'], + 'SmsType' => ['title' => '', 'description' => 'The SMS type.', 'type' => 'string', 'example' => '3：挂机短信'."\n" + .'4：群发短信'], + 'Content' => ['title' => '', 'description' => 'The SMS content.', 'type' => 'string', 'example' => '短信内容'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2021-09-26 11:34:59'], + 'TemplateName' => ['title' => '', 'description' => 'The template name.', 'type' => 'string', 'example' => '短信模板10926001'], + 'Sign' => ['title' => '', 'description' => 'The SMS signature.', 'type' => 'string', 'example' => 'a234n'], + 'TemplateType' => ['title' => '', 'description' => 'The templatetype.', 'type' => 'integer', 'format' => 'int64', 'example' => '1：普通短信模板'."\n" + .'2：智能短链模板'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the template.', 'type' => 'string', 'example' => '“尊称,姓名,金额"'], + 'TemplateId' => ['title' => '', 'description' => 'The template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '67'], + 'ShortUrlTaskId' => ['title' => '', 'description' => 'The intelligent short URL ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '46'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 2,\\n \\"PageSize\\": 42,\\n \\"TotalPage\\": 31,\\n \\"PageNo\\": 53,\\n \\"List\\": [\\n {\\n \\"Status\\": 0,\\n \\"SmsType\\": \\"3：挂机短信\\\\n4：群发短信\\",\\n \\"Content\\": \\"短信内容\\",\\n \\"CreateTime\\": \\"2021-09-26 11:34:59\\",\\n \\"TemplateName\\": \\"短信模板10926001\\",\\n \\"Sign\\": \\"a234n\\",\\n \\"TemplateType\\": 0,\\n \\"Properties\\": \\"“尊称,姓名,金额\\\\\\"\\",\\n \\"TemplateId\\": 67,\\n \\"ShortUrlTaskId\\": 46\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query SMS template list for industry edition', + 'description' => 'Queries the list of SMS templates for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplatePageList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplatePageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallChats' => [ - 'summary' => '查询聊天记录接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries chat records for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2480,9 +1989,7 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '180600', - 'abilityTreeNodes' => [ - 'FEATUREaiccs3JFNGJ', - ], + 'abilityTreeNodes' => ['FEATUREaiccs3JFNGJ'], 'autoTest' => true, 'tenantRelevance' => 'publicInformation', ], @@ -2490,48 +1997,22 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '26', - ], + 'schema' => ['title' => '', 'description' => 'The task ID in the decision system. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '26'], ], [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '72', - ], + 'schema' => ['title' => '', 'description' => 'The agent ID. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '72'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'AA', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the agent in your business system. This parameter is used to query the corresponding AgentId. This parameter can be left empty. At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', 'type' => 'string', 'required' => false, 'example' => 'AA'], ], [ 'name' => 'CallId', 'in' => 'query', - 'schema' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'required' => true, - 'example' => '9b2eb6b8-7a27-4357-b5ec-104450086e24', - ], + 'schema' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'required' => true, 'example' => '9b2eb6b8-7a27-4357-b5ec-104450086e24'], ], ], 'responses' => [ @@ -2539,81 +2020,66 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'FromNumber' => [ - 'title' => '说话号码', - 'description' => '说话号码', - 'type' => 'string', - 'example' => '138*****265', - ], - 'Content' => [ - 'title' => '说话内容', - 'description' => '说话内容', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CreateTime' => [ - 'title' => '说话时间', - 'description' => '说话时间', - 'type' => 'string', - 'example' => '2022-01-13 14:56:46.604', - ], + 'FromNumber' => ['title' => '', 'description' => 'The number of the speaker. A value of 0 indicates the robot.', 'type' => 'string', 'example' => '138*****265'], + 'Content' => ['title' => '', 'description' => 'The content of the speech.', 'type' => 'string', 'example' => '你好，请问是a吗？'], + 'CreateTime' => ['title' => '', 'description' => 'The time of the speech. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-13 14:56:46'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: The call was successful.'."\n" + .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"FromNumber\\": \\"138*****265\\",\\n \\"Content\\": \\"你好，请问是a吗？\\",\\n \\"CreateTime\\": \\"2022-01-13 14:56:46\\"\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query chat records for the industry edition', + 'description' => 'Queries chat records for the industry edition.', + 'requestParamsDescription' => 'At least one of the following parameters must have a value: TaskId, AgentId, and AgentTag. If multiple values are specified, the query is performed based on the following priority: TaskId > AgentId > AgentTag. Only the parameter with the highest priority is used for the query.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallChats'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallChats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallInfo' => [ - 'summary' => '获取任务外呼情况接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Retrieves the outbound call status of a task for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2621,24 +2087,12 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -2646,77 +2100,59 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '示例值示例值', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '示例值示例值示例值', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'FinishTotal' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75', - ], - 'UnCallTotal' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], + 'FinishTotal' => ['description' => 'The number of completed outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '75', 'title' => ''], + 'UnCallTotal' => ['description' => 'The number of outbound calls that failed to be made.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Total' => ['description' => 'The total number of outbound calls.', 'type' => 'integer', 'format' => 'int64', 'example' => '59', 'title' => ''], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '62', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"示例值示例值\\",\\n \\"RequestId\\": \\"示例值示例值示例值\\",\\n \\"Model\\": {\\n \\"FinishTotal\\": 75,\\n \\"UnCallTotal\\": 3,\\n \\"Total\\": 59\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 62,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Retrieve task outbound call status for the industry edition', + 'description' => 'Retrieves the outbound call status of a task for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallInfo'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCallList' => [ - 'summary' => 'AI批量任务查询外呼记录接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Queries outbound call records for an industry edition AI batch task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2729,30 +2165,17 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '93', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '93'], ], [ 'name' => 'IntentTags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent tag used to filter records. For example, if you set this parameter to "C", only records with intent tag C are returned. To query multiple intent tags, specify them as ["A","B","C"].', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '"A"', - ], + 'items' => ['description' => 'The intent tag.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '"A"'], 'required' => false, 'example' => '', ], @@ -2760,28 +2183,17 @@ [ 'name' => 'BatchId', 'in' => 'query', - 'schema' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The batch ID returned when phone numbers are imported.', 'type' => 'string', 'required' => false, 'example' => '1'], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The phone numbers to query. You can specify up to 1000 numbers for exact match.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '158*****196', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '158*****196', 'title' => ''], 'required' => false, 'example' => '', ], @@ -2789,48 +2201,22 @@ [ 'name' => 'CallDate', 'in' => 'query', - 'schema' => [ - 'title' => '开始外呼时间', - 'description' => '开始外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2022-01-25 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'The start date of outbound calls. You can query data only within the last 30 days. Format: 2020-03-06 10:10:10.', 'type' => 'string', 'required' => true, 'example' => '2022-01-25 00:00:00'], ], [ 'name' => 'EndCallDate', 'in' => 'query', - 'schema' => [ - 'title' => '结束外呼时间', - 'description' => '结束外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2022-01-25 00:00:00', - ], + 'schema' => ['title' => '', 'description' => 'The end time of outbound calls. You can query data for only one day. The start call date and end call date must be different time points on the same day. Format: 2020-03-06 10:10:10.', 'type' => 'string', 'required' => true, 'example' => '2022-01-25 00:00:00'], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '39', - ], + 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '39'], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页外呼记录数,正整数，默认10000', - 'description' => '每页外呼记录数,正整数，默认10000', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '97', - ], + 'schema' => ['title' => '', 'description' => 'The number of outbound call records per page. The value must be a positive integer. Default value: 10000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '97'], ], ], 'responses' => [ @@ -2838,349 +2224,154 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int64', 'example' => '95', 'title' => ''], + 'TotalPage' => ['description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '39', 'title' => ''], + 'PageNo' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '62', 'title' => ''], 'List' => [ - 'description' => '', + 'description' => 'The list of records.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The record.', 'type' => 'object', 'properties' => [ - 'AddWx' => [ - 'title' => '加微', - 'description' => '加微', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TaskId' => [ - 'title' => '外呼任务ID', - 'description' => '外呼任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AgentExtension' => [ - 'title' => '坐席分机', - 'description' => '坐席分机', - 'type' => 'string', - 'example' => '112', - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - 'AnswerTime' => [ - 'title' => '接通时间', - 'description' => '接通时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'IntentTag' => [ - 'title' => '意向标签', - 'description' => '意向标签', - 'type' => 'string', - 'example' => '“C”', - ], - 'TransferStatusCode' => [ - 'title' => '转人工状态编码', - 'description' => '转人工状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ImportTime' => [ - 'title' => '导入时间', - 'description' => '导入时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'IndividualTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => 'A', - ], - 'Properties' => [ - 'title' => '参数', - 'description' => '参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingDuration' => [ - 'title' => '人工通话时长', - 'description' => '人工通话时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98', - ], - 'Remark' => [ - 'title' => '备注', - 'description' => '备注', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'CallTimes' => [ - 'title' => '呼叫次数', - 'description' => '呼叫次数', - 'type' => 'string', - 'example' => '1', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '138*****123', - ], - 'InterceptReason' => [ - 'title' => '拦截原因', - 'description' => '拦截原因', - 'type' => 'string', - 'example' => '示例值', - ], - 'IntentDescription' => [ - 'title' => '意向说明', - 'description' => '意向说明', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'StatusDescription' => [ - 'title' => '外呼状态描述', - 'description' => '外呼状态描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SpeakingDuration' => [ - 'title' => 'AI通话时长', - 'description' => 'AI通话时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45', - ], - 'Gateway' => [ - 'title' => '外呼网关', - 'description' => '外呼网关', - 'type' => 'string', - 'example' => '123', - ], - 'TransferStatus' => [ - 'title' => '转人工状态', - 'description' => '转人工状态', - 'type' => 'string', - 'example' => '示例值', - ], - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '87', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'A', - ], - 'Status' => [ - 'title' => '外呼状态', - 'description' => '外呼状态', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '9197ed9e-ceda-42a5-b683-823b23ef208e', - ], - 'BatchId' => [ - 'title' => '批次ID', - 'description' => '批次ID', - 'type' => 'string', - 'example' => '1', - ], - 'HangupTime' => [ - 'title' => '挂断时间', - 'description' => '挂断时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'CallBeginTime' => [ - 'title' => '开始通话时间', - 'description' => '开始通话时间', - 'type' => 'string', - 'example' => '2022-01-26 18:58:25', - ], - 'RingTime' => [ - 'title' => '振铃时长', - 'description' => '振铃时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'AgentSpeakingTime' => [ - 'title' => '人工通话时长', - 'description' => '人工通话时长', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AddWxStatus' => [ - 'title' => '加微进度', - 'description' => '加微进度', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'HangupType' => [ - 'title' => '挂机方式', - 'description' => '挂机方式', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SpeakingTurns' => [ - 'title' => '对话轮次', - 'description' => '对话轮次', - 'type' => 'string', - 'example' => '0', - ], - 'Sms' => [ - 'title' => '挂机短信', - 'description' => '挂机短信', - 'type' => 'string', - 'example' => '示例值', - ], - 'AnswerRecall' => [ - 'title' => '是否接通重呼', - 'description' => '是否接通重呼', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => '示例值', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => '75916b635568954583783d', - ], - 'ChatRecord' => [ - 'title' => '对话录音', - 'description' => '对话录音', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SpeakingTime' => [ - 'title' => 'AI通话时长', - 'description' => 'AI通话时长', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], + 'AddWx' => ['title' => '', 'description' => 'Indicates whether to add WeChat. Valid values:'."\n" + .'- 0: Do not add.'."\n" + .'- 1: Add.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'TaskId' => ['title' => '', 'description' => 'The outbound call task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], + 'Keywords' => ['title' => '', 'description' => 'The reply keywords.', 'type' => 'string', 'example' => '好'], + 'AgentExtension' => ['title' => '', 'description' => 'The agent extension number.', 'type' => 'string', 'example' => '112'], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + .'- 1001: Agent - manual outbound call.'."\n" + .'- 1002: Agent - AI outbound call - no transfer to agent.'."\n" + .'- 1003: Agent - AI outbound call - transfer to agent upon connection.'."\n" + .'- 1004: Agent - AI outbound call - intelligent transfer to agent.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'AnswerTime' => ['title' => '', 'description' => 'The time when the call was answered. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'IntentTag' => ['title' => '', 'description' => 'The intent tag.', 'type' => 'string', 'example' => '“C”'], + 'TransferStatusCode' => ['title' => '', 'description' => 'The status code for transfer to agent, such as 1 or 2. This value can be empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The import time. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'IndividualTag' => ['title' => '', 'description' => 'The individual tags, such as "投诉,非本人". This value can be empty.', 'type' => 'string', 'example' => 'A'], + 'Properties' => ['title' => '', 'description' => 'The parameter values specified when phone numbers are imported, in JSON format.', 'type' => 'string', 'example' => '{\\"电话号码\\":\\"13100000000\\"}'], + 'StatusCode' => ['title' => '', 'description' => 'The outbound call status code, such as 1 or 2.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'AgentSpeakingDuration' => ['title' => '', 'description' => 'The agent speaking duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '98'], + 'Remark' => ['title' => '', 'description' => 'The manual remarks. Example:', 'type' => 'string', 'example' => '备注内容'], + 'CallTimes' => ['title' => '', 'description' => 'The number of call attempts.', 'type' => 'string', 'example' => '1'], + 'Number' => ['title' => '', 'description' => 'The outbound call number.', 'type' => 'string', 'example' => '138*****123'], + 'InterceptReason' => ['title' => '', 'description' => 'The interception reason. When the status is intercepted, valid values: blacklist interception, graylist interception, or abnormal number interception.', 'type' => 'string', 'example' => '黑名单拦截，灰名单拦截，异常号码拦截'], + 'IntentDescription' => ['title' => '', 'description' => 'The intent description, such as "确认本人,未承诺还款".', 'type' => 'string', 'example' => '如“确认本人,未承诺还款”'], + 'StatusDescription' => ['title' => '', 'description' => 'The outbound call status description.', 'type' => 'string', 'example' => '外呼状态，如“已接听”“拒接”'."\n" + .'注，转外呼状态编码与描述对应：'."\n" + .'1 "已接听",'."\n" + .'2 "关机",'."\n" + .'3 "空号",'."\n" + .'4 "改号",'."\n" + .'5 "停机",'."\n" + .'6 "占线",'."\n" + .'7 "拒接",'."\n" + .'8 "无法接通",'."\n" + .'9 "未接",'."\n" + .'10 "用户欠费",'."\n" + .'11 "线路故障",'."\n" + .'12 "呼叫失败"'."\n" + .'30 "已拦截" '."\n" + .'40 "单日呼叫次数受限"'."\n" + .'50 "取消外呼-已转化" '], + 'SpeakingDuration' => ['title' => '', 'description' => 'The call duration. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '45'], + 'Gateway' => ['title' => '', 'description' => 'The outbound call gateway.', 'type' => 'string', 'example' => '123'], + 'TransferStatus' => ['title' => '', 'description' => 'The transfer-to-agent status.', 'type' => 'string', 'example' => '转人工状态，可以为空，如未触发、分配坐席失败'."\n" + .'注，转人工状态编码与状态对应：'."\n" + .'0 "未触发",'."\n" + .'1 "分配坐席失败",'."\n" + .'2 "无空闲坐席分配",'."\n" + .'10 "振铃未接听",'."\n" + .'11 "振铃占线",'."\n" + .'12 "振铃话机离线",'."\n" + .'13 "振铃失败",'."\n" + .'14 "监听失败",'."\n" + .'20 "监听未接听",'."\n" + .'30 "已接听",'."\n" + .'31 "接听失败"'], + 'AgentId' => ['title' => '', 'description' => 'The agent ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '87'], + 'TemplateId' => ['title' => '', 'description' => 'The AI script ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '66'], + 'AgentTag' => ['title' => '', 'description' => 'The agent tag.', 'type' => 'string', 'example' => 'A'], + 'Status' => ['title' => '', 'description' => 'The outbound call status.', 'type' => 'string', 'example' => '未接、占线、拒接、用户欠费、线路故障、呼叫失败、已接听、无法接通、关机、停机、改号、空号、无效接通、已拦截、单日呼叫次数受限、取消外呼-已转化'], + 'CallId' => ['title' => '', 'description' => 'The outbound call ID.', 'type' => 'string', 'example' => '9197ed9e-ceda-42a5-b683-823b23ef208e'], + 'BatchId' => ['title' => '', 'description' => 'The batch ID.', 'type' => 'string', 'example' => '1'], + 'HangupTime' => ['title' => '', 'description' => 'The call hangup time. Format: 2019-01-09 14:14:19.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'CallBeginTime' => ['title' => '', 'description' => 'The call start time. Format: 2019-11-23 14:47:06.', 'type' => 'string', 'example' => '2022-01-26 18:58:25'], + 'RingTime' => ['title' => '', 'description' => 'The ring duration. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '66'], + 'AgentSpeakingTime' => ['title' => '', 'description' => 'The agent speaking duration. If the duration is greater than 1 minute, the value is displayed in minutes and seconds. If the duration is less than 1 minute, the value is displayed in seconds.', 'type' => 'string', 'example' => '0秒'], + 'AddWxStatus' => ['title' => '', 'description' => 'The WeChat addition progress.', 'type' => 'string', 'example' => '可选值：已申请、加微成功'], + 'HangupType' => ['title' => '', 'description' => 'The hangup type. Valid values:'."\n" + .'- 1: AI hangup.'."\n" + .'- 2: Agent hangup.'."\n" + .'- 3: Customer hangup.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'SpeakingTurns' => ['title' => '', 'description' => 'The number of conversation turns.', 'type' => 'string', 'example' => '0'], + 'Sms' => ['title' => '', 'description' => 'The post-hangup SMS message.', 'type' => 'string', 'example' => '1、2'."\n" + .'1:发送，2:不发送'], + 'AnswerRecall' => ['title' => '', 'description' => 'Indicates whether the call is a redial after connection.', 'type' => 'integer', 'format' => 'int64', 'example' => '可选值：0、1'."\n" + .'0正常外呼，1接通重呼'], + 'Tag' => ['title' => '', 'description' => 'The user-defined tag.', 'type' => 'string', 'example' => '好'], + 'NumberMD5' => ['title' => '', 'description' => 'The MD5 hash of the outbound call number.', 'type' => 'string', 'example' => '75916b635568954583783d'], + 'ChatRecord' => ['title' => '', 'description' => 'The conversation recording.', 'type' => 'string', 'example' => 'URL，可以为空'], + 'SpeakingTime' => ['title' => '', 'description' => 'The call duration. If the duration is greater than 1 minute, the value is displayed in minutes and seconds. If the duration is less than 1 minute, the value is displayed in seconds.', 'type' => 'string', 'example' => '0秒'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 80,\\n \\"PageSize\\": 95,\\n \\"TotalPage\\": 39,\\n \\"PageNo\\": 62,\\n \\"List\\": [\\n {\\n \\"AddWx\\": 0,\\n \\"TaskId\\": 70,\\n \\"Keywords\\": \\"好\\",\\n \\"AgentExtension\\": \\"112\\",\\n \\"CallType\\": 1001,\\n \\"AnswerTime\\": \\"2022-01-26 18:58:25\\",\\n \\"IntentTag\\": \\"“C”\\",\\n \\"TransferStatusCode\\": 1,\\n \\"ImportTime\\": \\"2022-01-26 18:58:25\\",\\n \\"IndividualTag\\": \\"A\\",\\n \\"Properties\\": \\"{\\\\\\\\\\\\\\"电话号码\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"13100000000\\\\\\\\\\\\\\"}\\",\\n \\"StatusCode\\": 1,\\n \\"AgentSpeakingDuration\\": 98,\\n \\"Remark\\": \\"备注内容\\",\\n \\"CallTimes\\": \\"1\\",\\n \\"Number\\": \\"138*****123\\",\\n \\"InterceptReason\\": \\"黑名单拦截，灰名单拦截，异常号码拦截\\",\\n \\"IntentDescription\\": \\"如“确认本人,未承诺还款”\\",\\n \\"StatusDescription\\": \\"外呼状态，如“已接听”“拒接”\\\\n注，转外呼状态编码与描述对应：\\\\n1 \\\\\\"已接听\\\\\\",\\\\n2 \\\\\\"关机\\\\\\",\\\\n3 \\\\\\"空号\\\\\\",\\\\n4 \\\\\\"改号\\\\\\",\\\\n5 \\\\\\"停机\\\\\\",\\\\n6 \\\\\\"占线\\\\\\",\\\\n7 \\\\\\"拒接\\\\\\",\\\\n8 \\\\\\"无法接通\\\\\\",\\\\n9 \\\\\\"未接\\\\\\",\\\\n10 \\\\\\"用户欠费\\\\\\",\\\\n11 \\\\\\"线路故障\\\\\\",\\\\n12 \\\\\\"呼叫失败\\\\\\"\\\\n30 \\\\\\"已拦截\\\\\\" \\\\n40 \\\\\\"单日呼叫次数受限\\\\\\"\\\\n50 \\\\\\"取消外呼-已转化\\\\\\" \\",\\n \\"SpeakingDuration\\": 45,\\n \\"Gateway\\": \\"123\\",\\n \\"TransferStatus\\": \\"转人工状态，可以为空，如未触发、分配坐席失败\\\\n注，转人工状态编码与状态对应：\\\\n0 \\\\\\"未触发\\\\\\",\\\\n1 \\\\\\"分配坐席失败\\\\\\",\\\\n2 \\\\\\"无空闲坐席分配\\\\\\",\\\\n10 \\\\\\"振铃未接听\\\\\\",\\\\n11 \\\\\\"振铃占线\\\\\\",\\\\n12 \\\\\\"振铃话机离线\\\\\\",\\\\n13 \\\\\\"振铃失败\\\\\\",\\\\n14 \\\\\\"监听失败\\\\\\",\\\\n20 \\\\\\"监听未接听\\\\\\",\\\\n30 \\\\\\"已接听\\\\\\",\\\\n31 \\\\\\"接听失败\\\\\\"\\",\\n \\"AgentId\\": 87,\\n \\"TemplateId\\": 66,\\n \\"AgentTag\\": \\"A\\",\\n \\"Status\\": \\"未接、占线、拒接、用户欠费、线路故障、呼叫失败、已接听、无法接通、关机、停机、改号、空号、无效接通、已拦截、单日呼叫次数受限、取消外呼-已转化\\",\\n \\"CallId\\": \\"9197ed9e-ceda-42a5-b683-823b23ef208e\\",\\n \\"BatchId\\": \\"1\\",\\n \\"HangupTime\\": \\"2022-01-26 18:58:25\\",\\n \\"CallBeginTime\\": \\"2022-01-26 18:58:25\\",\\n \\"RingTime\\": 66,\\n \\"AgentSpeakingTime\\": \\"0秒\\",\\n \\"AddWxStatus\\": \\"可选值：已申请、加微成功\\",\\n \\"HangupType\\": 1,\\n \\"SpeakingTurns\\": \\"0\\",\\n \\"Sms\\": \\"1、2\\\\n1:发送，2:不发送\\",\\n \\"AnswerRecall\\": 0,\\n \\"Tag\\": \\"好\\",\\n \\"NumberMD5\\": \\"75916b635568954583783d\\",\\n \\"ChatRecord\\": \\"URL，可以为空\\",\\n \\"SpeakingTime\\": \\"0秒\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'Query outbound call records for an industry edition AI batch task', + 'description' => 'Queries outbound call records for an industry edition AI batch task.', + 'requestParamsDescription' => 'The end time of outbound calls. You can query data for only one day. The start call date and end call date must be different time points on the same day. Format: 2020-03-06 10:10:10.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskCancelCall' => [ - 'summary' => '批量任务取消号码外呼', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Cancels outbound calls for a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3188,43 +2379,24 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30', - 'default' => '', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '30', 'default' => ''], ], [ 'name' => 'Numbers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13661109390', - ], + 'items' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13661109390'], 'required' => false, 'example' => '', + 'title' => '', ], ], [ @@ -3232,18 +2404,13 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The list of labels.', 'type' => 'array', - 'items' => [ - 'title' => '用户自定义标签', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['title' => '', 'description' => 'The custom label.', 'type' => 'string', 'required' => false, 'example' => 'tag1'], 'required' => false, 'example' => '', 'default' => '', + 'title' => '', ], ], ], @@ -3252,69 +2419,62 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机号', - 'description' => '错误手机号', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13541251222,18665214444', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful. Valid values:'."\n" + .'- **true**: Successful.'."\n" + .'- **false**: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13541251222,18665214444\\"\\n ]\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'TaskList' => [ - 'summary' => '查询任务列表接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Cancel outbound calls for a task in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCancelCall'], + ], ], + ], + 'TaskList' => [ + 'summary' => 'Queries the task list for the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3327,290 +2487,198 @@ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ 'name' => 'LastCallTime', 'in' => 'query', - 'schema' => [ - 'title' => '最后外呼时间', - 'description' => '最后外呼时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-05 12:11:11', - ], + 'schema' => ['title' => '', 'description' => 'The time of the last outbound call.', 'type' => 'string', 'required' => false, 'example' => '2023-04-05 12:11:11'], ], [ 'name' => 'CreateTime', 'in' => 'query', - 'schema' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'required' => false, - 'example' => '2023-04-05 12:11:11', - ], + 'schema' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'required' => false, 'example' => '2023-04-05 12:11:11'], ], [ 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'title' => '任务状态。1 未启用，2 启用中，4 已停止', - 'description' => '任务状态。1 未启用，2 启用中，4 已停止', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 2: Published.'."\n" + ."\n" + .'- 4: Disabled.'."\n" + ."\n" + .'- 6: Deleted.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'AccessDeniedDetail' => [ - 'type' => 'string', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'AccessDeniedDetail' => ['description' => 'The detailed reason for the access denial.', 'type' => 'string', 'example' => '{}', 'title' => ''], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功'."\n", 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-****-1ECA-****-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'title' => '任务状态', - 'description' => '任务状态', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - 'AllowDayOfWeek' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'string', - 'example' => '“1,2,3”', - ], - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '68', - ], + 'Status' => ['title' => '', 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- 2: Published.'."\n" + ."\n" + .'- 4: Disabled.'."\n" + ."\n" + .'- 6: Deleted.', 'type' => 'integer', 'format' => 'int64', 'example' => '4'], + 'AllowDayOfWeek' => ['title' => '', 'description' => 'The outbound call days of the week. Valid values:'."\n" + ."\n" + .'- 1: Monday.'."\n" + ."\n" + .'- 2: Tuesday.'."\n" + ."\n" + .'- 3: Wednesday.'."\n" + ."\n" + .'- 4: Thursday.'."\n" + ."\n" + .'- 5: Friday.'."\n" + ."\n" + .'- 6: Saturday.'."\n" + ."\n" + .'- 7: Sunday.', 'type' => 'string', 'example' => '1,2,3'], + 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '68'], 'IntentTags' => [ - 'title' => '意向标签列表', - 'description' => '意向标签列表', + 'title' => '', + 'description' => 'The list of intent tags.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The intent tag object.', 'type' => 'object', 'properties' => [ - 'IntentDescription' => [ - 'title' => '意向标签描述', - 'description' => '意向标签描述', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'IntentTag' => [ - 'title' => '意向标签ID', - 'description' => '意向标签ID', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'IntentDescription' => ['title' => '', 'description' => 'The description of the intent tag.', 'type' => 'string', 'example' => '满意'], + 'IntentTag' => ['title' => '', 'description' => 'The intent tag ID.', 'type' => 'string', 'example' => '123'], ], + 'title' => '', + 'example' => '', ], 'example' => '', ], - 'Priority' => [ - 'title' => '优先任务', - 'description' => '优先任务', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '66', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11'."\n", - ], - 'CallType' => [ - 'title' => '外呼类型', - 'description' => '外呼类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], - 'MaxConcurrency' => [ - 'title' => '最大并发数', - 'description' => '最大并发数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95', - ], + 'Priority' => ['title' => '', 'description' => 'Specifies whether the task is a priority task. Valid values:'."\n" + ."\n" + .'- 1: No.'."\n" + ."\n" + .'- 2: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'."\n"], + 'CallType' => ['title' => '', 'description' => 'The outbound call type. Valid values:'."\n" + ."\n" + .'- 1001: Agent - manual outbound call.'."\n" + ."\n" + .'- 1002: Agent - AI outbound call - no transfer to agent.'."\n" + ."\n" + .'- 1003: Agent - AI outbound call - transfer to agent upon connection.'."\n" + ."\n" + .'- 1004: Agent - AI outbound call - intelligent transfer to agent.'."\n" + ."\n" + .'- 2001: Batch - predictive outbound call.'."\n" + ."\n" + .'- 2002: Batch - AI outbound call - no transfer to agent.'."\n" + ."\n" + .'- 2003: Batch - AI outbound call - transfer to agent upon connection.'."\n" + ."\n" + .'- 2004: Batch - AI outbound call - intelligent transfer to agent.'."\n" + ."\n" + .'- 2005: Batch - voice notification.', 'type' => 'integer', 'format' => 'int64', 'example' => '1001'], + 'MaxConcurrency' => ['title' => '', 'description' => 'The maximum concurrency.', 'type' => 'integer', 'format' => 'int64', 'example' => '95'], 'PersonalityTags' => [ - 'title' => '个性标签列表', - 'description' => '个性标签列表', + 'title' => '', + 'description' => 'The list of personality tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'AA', - ], + 'items' => ['description' => 'The personality tag.', 'type' => 'string', 'example' => 'AA', 'title' => ''], 'example' => '', ], - 'SendSms' => [ - 'title' => '发送短信', - 'description' => '发送短信', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '39', - ], - 'ImportTime' => [ - 'title' => '最近导入时间', - 'description' => '最近导入时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11', - ], - 'Properties' => [ - 'title' => '任务所需参数', - 'description' => '任务所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'FlashSmsTemplateName' => [ - 'title' => '闪信模板名称', - 'description' => '闪信模板名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'AllowCallTimeFormat' => [ - 'title' => '外呼时间段格式化', - 'description' => '外呼时间段格式化', - 'type' => 'string', - 'example' => '“8:00 ~ 20:00”', - ], - 'LastCallTime' => [ - 'title' => '最后外呼时间', - 'description' => '最后外呼时间', - 'type' => 'string', - 'example' => '2023-04-05 12:11:11', - ], - 'TaskName' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RecallType' => [ - 'title' => '自动重呼', - 'description' => '自动重呼', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TemplateName' => [ - 'title' => '话术模板名称', - 'description' => '话术模板名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'SmsName' => [ - 'title' => '短信模板', - 'description' => '短信模板', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'AllowCallTime' => [ - 'title' => '外呼时间段', - 'description' => '外呼时间段', - 'type' => 'string', - 'example' => '“8:00~20:30”', - ], - 'FlashSmsTemplateId' => [ - 'title' => '闪信模板id', - 'description' => '闪信模板id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '99', - ], - 'TemplateId' => [ - 'title' => '话术模板Id', - 'description' => '话术模板Id', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'InvalidReCall' => [ - 'title' => '接通重呼次数', - 'description' => '接通重呼次数', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '31', - ], - 'FlashSmsType' => [ - 'title' => '发送闪信配置，可选0，1；0表示否，1表示是', - 'description' => '发送闪信配置，可选0，1；0表示否，1表示是', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], + 'SendSms' => ['title' => '', 'description' => 'Specifies whether to send SMS messages. Valid values:'."\n" + ."\n" + .'- 1: No.'."\n" + ."\n" + .'- 2: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'ImportTime' => ['title' => '', 'description' => 'The most recent import time.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the task.', 'type' => 'string', 'example' => '尊称，姓名，金额'], + 'FlashSmsTemplateName' => ['title' => '', 'description' => 'The flash SMS template name.', 'type' => 'string', 'example' => '示例值'], + 'AllowCallTimeFormat' => ['title' => '', 'description' => 'The formatted outbound call time period.', 'type' => 'string', 'example' => '9:00 ~ 12:00\\n13.5 ~ 20'], + 'LastCallTime' => ['title' => '', 'description' => 'The time of the last outbound call.', 'type' => 'string', 'example' => '2023-04-05 12:11:11'], + 'TaskName' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => '第一个外呼任务'], + 'RecallType' => ['title' => '', 'description' => 'The automatic recall type. Valid values:'."\n" + ."\n" + .'- 1: No recall.'."\n" + ."\n" + .'- 2: Interval recall.'."\n" + ."\n" + .'- 3: Scheduled recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'TemplateName' => ['title' => '', 'description' => 'The script template name.', 'type' => 'string', 'example' => '第一个话术'], + 'SmsName' => ['title' => '', 'description' => 'The SMS template.', 'type' => 'string', 'example' => '短信02np'], + 'AllowCallTime' => ['title' => '', 'description' => 'The outbound call time period.', 'type' => 'string', 'example' => '[[9,12],[[13.5,20]]]'], + 'FlashSmsTemplateId' => ['title' => '', 'description' => 'The flash SMS template ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '99'], + 'TemplateId' => ['title' => '', 'description' => 'The script template ID.', 'type' => 'string', 'example' => '123'], + 'InvalidReCall' => ['title' => '', 'description' => 'The recall setting for connected calls. Valid values:'."\n" + ."\n" + .'- 1: No recall.'."\n" + ."\n" + .'- 2: Recall.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'FlashSmsType' => ['title' => '', 'description' => 'Specifies whether to send flash SMS messages. Valid values:'."\n" + ."\n" + .'- 0: No.'."\n" + ."\n" + .'- 1: Yes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + ], + 'title' => '', + 'example' => '', ], 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'title' => '', + ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '80', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"{}\\",\\n \\"Message\\": \\"成功\\\\n\\",\\n \\"RequestId\\": \\"8EFC6D10-****-1ECA-****-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"Status\\": 4,\\n \\"AllowDayOfWeek\\": \\"1,2,3\\",\\n \\"TaskId\\": 68,\\n \\"IntentTags\\": [\\n {\\n \\"IntentDescription\\": \\"满意\\",\\n \\"IntentTag\\": \\"123\\"\\n }\\n ],\\n \\"Priority\\": 1,\\n \\"CreateTime\\": \\"2023-04-05 12:11:11\\\\n\\",\\n \\"CallType\\": 1001,\\n \\"MaxConcurrency\\": 95,\\n \\"PersonalityTags\\": [\\n \\"AA\\"\\n ],\\n \\"SendSms\\": 1,\\n \\"ImportTime\\": \\"2023-04-05 12:11:11\\",\\n \\"Properties\\": \\"尊称，姓名，金额\\",\\n \\"FlashSmsTemplateName\\": \\"示例值\\",\\n \\"AllowCallTimeFormat\\": \\"9:00 ~ 12:00\\\\\\\\n13.5 ~ 20\\",\\n \\"LastCallTime\\": \\"2023-04-05 12:11:11\\",\\n \\"TaskName\\": \\"第一个外呼任务\\",\\n \\"RecallType\\": 1,\\n \\"TemplateName\\": \\"第一个话术\\",\\n \\"SmsName\\": \\"短信02np\\",\\n \\"AllowCallTime\\": \\"[[9,12],[[13.5,20]]]\\",\\n \\"FlashSmsTemplateId\\": 99,\\n \\"TemplateId\\": \\"123\\",\\n \\"InvalidReCall\\": 1,\\n \\"FlashSmsType\\": 1\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 80,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query task list for industry edition', + 'description' => 'Queries the task list for the industry edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'TaskRecoverCall' => [ - 'summary' => '批量任务恢复号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Resumes outbound calls for canceled numbers in a task (industry edition). For numbers that have been canceled in a task, you can call this operation to resume them and add them back to the outbound call queue.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3618,40 +2686,22 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '93', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '93'], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', + 'title' => '', + 'description' => 'The list of custom tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], + 'items' => ['description' => 'The label.', 'type' => 'string', 'required' => false, 'example' => 'tag1', 'title' => ''], 'required' => false, 'example' => '', ], @@ -3661,15 +2711,10 @@ 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', + 'title' => '', + 'description' => 'The list of phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222,18665214444', - ], + 'items' => ['description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13541251222,18665214444', 'title' => ''], 'required' => false, 'example' => '', ], @@ -3677,24 +2722,12 @@ [ 'name' => 'BeginImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询开始导入时间', - 'description' => '查询开始导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2023-01-09 18:58:19"'], ], [ 'name' => 'EndImportTime', 'in' => 'query', - 'schema' => [ - 'title' => '查询结束导入时间', - 'description' => '查询结束导入时间', - 'type' => 'string', - 'required' => false, - 'example' => '"2023-01-09 18:58:19"', - ], + 'schema' => ['title' => '', 'description' => 'The end time of the import time range to query.', 'type' => 'string', 'required' => false, 'example' => '"2023-01-09 18:58:19"'], ], ], 'responses' => [ @@ -3702,57 +2735,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2', 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '无内容', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'TemplateList' => [ - 'summary' => '话术模板列表查询接口', - 'methods' => [ - 'post', - 'get', + 'title' => 'Resume task outbound calls (industry edition)', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:TaskRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskRecoverCall'], + ], ], + ], + 'TemplateList' => [ + 'summary' => 'Queries the list of industry edition script templates.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3765,125 +2789,94 @@ [ 'name' => 'TemplateId', 'in' => 'query', - 'schema' => [ - 'title' => '必须空参', - 'description' => '必须空参', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '9', - ], + 'schema' => ['title' => '', 'description' => 'Required empty parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ 'IntentTags' => [ - 'title' => '意向标签', - 'description' => '意向标签', + 'title' => '', + 'description' => 'The intent tags.', 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => '', - 'type' => 'object', - 'example' => '', - ], + 'items' => ['description' => '{'."\n" + .' "intentDescription": "已成为客户",'."\n" + .' "intentTag": "A"'."\n" + .' }.', 'type' => 'object', 'title' => '', 'example' => '{'."\n" + .' "intentDescription": "已成为客户",'."\n" + .' "intentTag": "A"'."\n" + .' }'], 'example' => '', ], - 'TemplateName' => [ - 'title' => '话术模板名称', - 'description' => '话术模板名称', - 'type' => 'string', - 'example' => '示例值示例值', - ], + 'TemplateName' => ['title' => '', 'description' => 'The name of the script template.', 'type' => 'string', 'example' => '模板'], 'PersonalityTags' => [ - 'title' => '个性标签', - 'description' => '个性标签', + 'title' => '', + 'description' => 'The personality tags.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '', - ], + 'items' => ['description' => 'The tag.', 'type' => 'string', 'example' => '标签', 'title' => ''], 'example' => '', ], - 'TemplateType' => [ - 'title' => '模板类型', - 'description' => '模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '55', - ], - 'Properties' => [ - 'title' => '话术所需参数', - 'description' => '话术所需参数', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59', - ], + 'TemplateType' => ['title' => '', 'description' => 'The template type.', 'type' => 'integer', 'format' => 'int64', 'example' => '1：单模版；2：智能话术策略模板。'], + 'Properties' => ['title' => '', 'description' => 'The parameters required by the script.', 'type' => 'string', 'example' => '"尊称,姓名,金额"'], + 'TemplateId' => ['title' => '', 'description' => 'The AI script ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59'], ], + 'title' => '', + 'example' => '', ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": [\\n {\\n \\"IntentTags\\": [\\n {\\n \\"intentDescription\\": \\"已成为客户\\",\\n \\"intentTag\\": \\"A\\"\\n }\\n ],\\n \\"TemplateName\\": \\"模板\\",\\n \\"PersonalityTags\\": [\\n \\"标签\\"\\n ],\\n \\"TemplateType\\": 0,\\n \\"Properties\\": \\"\\\\\\"尊称,姓名,金额\\\\\\"\\",\\n \\"TemplateId\\": 59\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": false\\n}","type":"json"}]', + 'title' => 'List industry edition script templates', + 'description' => 'Queries the list of industry edition script templates.', + 'requestParamsDescription' => 'TemplateId is an invalid parameter and does not need to be specified. This parameter serves only as a placeholder because the platform requires at least one request parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TemplateList'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], 'UpdateAgentStatus' => [ - 'summary' => '修改坐席状态', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'summary' => 'Updates the status of an agent in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3891,48 +2884,26 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'AgentId', 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '58', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the agent.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '58'], ], [ 'name' => 'AgentTag', 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abac', - ], + 'schema' => ['title' => '', 'description' => 'The tag of the agent.', 'type' => 'string', 'required' => false, 'example' => 'abac'], ], [ 'name' => 'AgentStatus', 'in' => 'query', - 'schema' => [ - 'title' => '坐席状态 1:在线；2:忙碌；3:小休；4:离线', - 'description' => '坐席状态 1:在线；2:忙碌；3:小休；4:离线', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The status of the agent. Valid values:'."\n" + .'- 1: online'."\n" + .'- 2: busy'."\n" + .'- 3: on break'."\n" + .'- 4: offline.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], ], ], 'responses' => [ @@ -3940,57 +2911,48 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], + 'Model' => ['description' => 'The returned result.', 'type' => 'object', 'example' => '无内容', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'UpdateTaskCustomer' => [ - 'summary' => '更新当天导入的号码', - 'methods' => [ - 'post', - 'get', + 'title' => 'Update agent status in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAgentStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAgentStatus'], + ], ], + ], + 'UpdateTaskCustomer' => [ + 'summary' => 'Updates the number parameters of a task in the industry edition.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3998,69 +2960,35 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '59', - ], + 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '59'], ], [ 'name' => 'Customers', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'title' => '外呼客户', - 'description' => '外呼客户', + 'title' => '', + 'description' => 'The outbound call customers.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The number details.', 'type' => 'object', 'properties' => [ - 'Number' => [ - 'title' => '电话号码', - 'description' => '电话号码', - 'type' => 'string', - 'required' => false, - 'example' => '13661109390', - ], - 'Cancel' => [ - 'title' => '是否取消外呼 0否，1是', - 'description' => '是否取消外呼 0否，1是', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'Properties' => [ - 'title' => '需根据具体任务参数要求传输', - 'description' => '需根据具体任务参数要求传输', - 'type' => 'object', - 'required' => false, - 'example' => '{"test":"234"}', - ], + 'Number' => ['title' => '', 'description' => 'The phone number.', 'type' => 'string', 'required' => false, 'example' => '13661109390'], + 'Cancel' => ['title' => '', 'description' => 'Specifies whether to cancel the outbound call. Valid values:'."\n" + .'- 0: Do not cancel.'."\n" + .'- 1: Cancel.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0'], + 'Tag' => ['title' => '', 'description' => 'The user-defined label.', 'type' => 'string', 'required' => false, 'example' => 'tag1'], + 'Properties' => ['title' => '', 'description' => 'The properties that must be specified based on the specific task parameter requirements.', 'type' => 'object', 'required' => false, 'example' => '{"test":"234"}'], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, 'example' => '', @@ -4072,2408 +3000,418 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", - ], + 'Message' => ['description' => 'The description of the status code.', 'type' => 'string', 'example' => '成功', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2'."\n", 'title' => ''], 'Model' => [ - 'description' => '', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ 'UnHandleNumbers' => [ - 'title' => '错误手机列表', - 'description' => '错误手机列表', + 'title' => '', + 'description' => 'The list of unrecognized phone numbers.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'example' => '13661109390', - ], + 'items' => ['description' => 'The unrecognized phone number.', 'type' => 'string', 'example' => '13661109390', 'title' => ''], 'example' => '', ], ], 'example' => '', + 'title' => '', ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1683440860035', - ], - 'Success' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], + 'Code' => ['description' => 'The status code. A value of 0 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Timestamp' => ['description' => 'The operation timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1683440860035', 'title' => ''], + 'Success' => ['description' => 'The result of the request. Valid values:'."\n" + .'- true: The request was successful.'."\n" + .'- false: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"成功\\",\\n \\"RequestId\\": \\"8EFC6D10-307B-1ECA-A8C6-7CBDF776AAD2\\\\n\\",\\n \\"Model\\": {\\n \\"UnHandleNumbers\\": [\\n \\"13661109390\\"\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 1683440860035,\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - ], - 'QuickAddTask' => [ - 'summary' => '快速创建任务接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '任务名称', - 'description' => '任务名称', - 'type' => 'string', - 'required' => true, - 'example' => 'a', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '任务启动日期', - 'description' => '任务启动日期', - 'type' => 'string', - 'required' => false, - 'example' => '2019-04-30', - ], - ], - [ - 'name' => 'TemplateType', - 'in' => 'query', - 'schema' => [ - 'title' => '话术模板类型', - 'description' => '话术模板类型', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1：单模版；2：智能话术策略模板。不填默认1。', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '话术模板ID,如果不传则使用被复制任务的话术模板', - 'description' => '话术模板ID,如果不传则使用被复制任务的话术模板', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'SmsTemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => '短信模板ID', - 'description' => '短信模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ReferenceTaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '被复制任务ID', - 'description' => '被复制任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CallTimeList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'array', - 'items' => [ - 'title' => '外呼时间', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CallTime' => [ - 'title' => '外呼时间', - 'description' => '外呼时间', - 'type' => 'array', - 'items' => [ - 'title' => '外呼时间', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '8.5', - ], - 'required' => false, - 'example' => '', - ], - ], - 'required' => false, + 'title' => 'Update task number parameters in the industry edition', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateTaskCustomer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, - 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务id', - 'description' => '任务id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskCustomer'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 77,\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'AddAgent' => [ - 'summary' => '创建坐席', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + ], + 'endpoints' => [ + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-north-2-gov-1', 'regionName' => 'Beijing Government Cloud', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'aiccs.aliyuncs.com', 'endpoint' => 'aiccs.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'CorpusCreateFailure', 'message' => 'Failed to create the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'CorpusDeleteFailure', 'message' => 'Failed to delete the corpus.', 'http_code' => 400, 'description' => ''], + ['code' => 'Department.NotFound', 'message' => 'The specified department does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Forbidden.Operation', 'message' => 'No permissions for this operation.', 'http_code' => 400, 'description' => 'No operation permission'], + ['code' => 'InvalidCustomer.NotFound', 'message' => 'Failed to query customers.', 'http_code' => 400, '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' => 'InvalidParameter.ApplicationCode', 'message' => 'The specified parameter "ApplicationCode" is invalid.', 'http_code' => 400, 'description' => 'The parameter ApplicationCode is invalid.'], + ['code' => 'InvalidParameter.CallDate', 'message' => 'The specified parameter "CallDate" is not valid.', 'http_code' => 400, 'description' => 'Invalid CallDate.'], + ['code' => 'InvalidParameter.CallId', 'message' => 'The parameter CallId is invalid.', 'http_code' => 400, 'description' => 'The parameter CallId is invalid.'."\n"], + ['code' => 'InvalidPartnerId.NotFound', 'message' => 'You must specify PartnerId.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidUserInfo.Exception', 'message' => 'Failed to query user information.', 'http_code' => 400, 'description' => ''], + ['code' => 'INVALID_SUMMARY_AGENT', 'message' => 'summary agent is invalid.', 'http_code' => 400, 'description' => 'Subtotal Intelligence Illegal'], + ['code' => 'INVALID_TASK_NAME', 'message' => 'taskName is invalid.', 'http_code' => 400, 'description' => 'Invalid task name'], + ['code' => 'MissingParameter.CallerNumber', 'message' => 'Parameter "CallerNumber" which is mandatory for the request is not provided.', 'http_code' => 400, 'description' => 'The request required parameter "CallerNumber" was not provided ".'], + ['code' => 'ModelCreateFailure', 'message' => 'Failed to create the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelDeleteFailure', 'message' => 'Failed to delete the the model.', 'http_code' => 400, 'description' => ''], + ['code' => 'ModelNotExist', 'message' => 'The model does not exist.', 'http_code' => 400, 'description' => 'The model does not exist.'], + ['code' => 'ModelStatus.Invalid', 'message' => 'Model state invalid.', 'http_code' => 400, 'description' => 'Invalid model state.'], + ['code' => 'ModelUpperLimitReached', 'message' => 'The maximum number of models is exceeded.', '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' => 'Parameter.Error', 'message' => 'Parameter error.', 'http_code' => 400, 'description' => ''], + ['code' => 'Parameter.Exception', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'ParameterError', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Permission.NotAuthorized', 'message' => 'Insufficient permissions. Please contact the primary account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'PermissionInsufficient', 'message' => 'Insufficient permissions. Please contact the Alibaba Cloud account administrator.', 'http_code' => 400, 'description' => ''], + ['code' => 'RequestParamError', 'message' => 'The request parameter you sent is abnormal. Please check.', 'http_code' => 501, 'description' => 'The request parameter you sent is abnormal. Please check!'], + ['code' => 'SUMMARY_AGENT_NOT_ONLINE', 'message' => 'summary agent is not online.', 'http_code' => 400, 'description' => 'Subtotal intelligences not online'], + ['code' => 'SystemError', 'message' => 'A system error occurred. Please contact the administrator.', 'http_code' => 500, 'description' => ''], + ['code' => 'SystemHandleFail', 'message' => 'A system error occurred while processing your request.', 'http_code' => 500, 'description' => 'A system error occurred while processing your request.'], + ['code' => 'TASK_FILE_NOT_EXIST', 'message' => 'task file is not exist.', 'http_code' => 400, 'description' => 'Tasks'], + ['code' => 'TrainFailure', 'message' => 'Model training failed.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabCreateFailure', 'message' => 'Failed to create the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabDeleteFailure', 'message' => 'Failed to delete the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileEmpty', 'message' => 'The vocab file cannot be empty.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabFileNotExist', 'message' => 'The vocab file does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpdateFailure', 'message' => 'Failed to update the vocab.', 'http_code' => 400, 'description' => ''], + ['code' => 'VocabUpperLimitReached', 'message' => 'The maximum number of vocab groups is exceeded.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each word cannot exceed 10 characters.', 'http_code' => 400, 'description' => ''], + ['code' => 'WordExceed', 'message' => 'Each group of vocabs cannot exceed 128 words.', 'http_code' => 400, 'description' => ''], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ImportNumberV2'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + 'createdAt' => '2025-05-13T14:41:14.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '2000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ImportNumber'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TemplateList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallInfo'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentCancelCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Page'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplatePageList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskRecoverCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AgentRecoverCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Details'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SmsTemplateCreate'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCancelCall'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallList'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EditTask'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTaskCustomer'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddBlacklist'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TaskCallChats'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateAgentStatus'], + ], + ], + 'ram' => [ + 'productCode' => 'AICCS', + 'productName' => 'Artificial Intelligence Cloud Call Service', + 'ramCodes' => ['aiccs'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'TaskCallInfo', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Account', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席账号名(必须唯一)', - 'description' => '坐席账号名(必须唯一)', - 'type' => 'string', - 'required' => true, - 'example' => 'seat_001', - ], - ], - [ - 'name' => 'Password', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席账号密码 (可以跟分机密码一致)', - 'description' => '坐席账号密码 (可以跟分机密码一致)', - 'type' => 'string', - 'required' => true, - 'example' => 'gwegwe23t32', - ], - ], - [ - 'name' => 'ExtensionPwd', - 'in' => 'query', - 'schema' => [ - 'title' => '分机密码', - 'description' => '分机密码', - 'type' => 'string', - 'required' => true, - 'example' => 'gwegwe23t32', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席名称', - 'description' => '坐席名称', - 'type' => 'string', - 'required' => true, - 'example' => 'xxx', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '合作方唯一标识', - 'description' => '合作方唯一标识', - 'type' => 'string', - 'required' => false, - 'example' => 'abc', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'object', - 'properties' => [ - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '82', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"AgentId\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 82,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QueryAgentInfo' => [ - 'summary' => '查询坐席具体信息', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskCancelCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => '"1"', + 'ramAction' => [ + 'action' => 'aiccs:TaskCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Account' => [ - 'title' => '坐席账号', - 'description' => '坐席账号', - 'type' => 'string', - 'example' => 'a', - ], - 'WsRegisterAddress' => [ - 'title' => 'WebSocket分机注册地址', - 'description' => 'WebSocket分机注册地址', - 'type' => 'string', - 'example' => 'a', - ], - 'AgentExtension' => [ - 'title' => '坐席分机号', - 'description' => '坐席分机号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => '创建时间', - 'type' => 'string', - 'example' => '2026-11-11 11:11:11', - ], - 'AgentGroupIds' => [ - 'title' => '坐席组ID列表', - 'description' => '坐席组ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - ], - 'example' => '', - ], - 'WsProtocol' => [ - 'title' => 'WebSocket分机注册协议', - 'description' => 'WebSocket分机注册协议', - 'type' => 'string', - 'example' => 'b', - ], - 'AgentGroupList' => [ - 'title' => '坐席组列表', - 'description' => '坐席组列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => 'a', - ], - 'GroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'example' => '', - ], - 'Name' => [ - 'title' => '坐席名称', - 'description' => '坐席名称', - 'type' => 'string', - 'example' => 'b', - ], - 'Active' => [ - 'title' => '账号启用状态，0-停用，1-启用，默认1', - 'description' => '账号启用状态，0-停用，1-启用，默认1', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentStatus' => [ - 'title' => '坐席状态，1:在线；2:忙碌；3:小休；4:离线', - 'description' => '坐席状态，1:在线；2:忙碌；3:小休；4:离线', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExtensionPwd' => [ - 'title' => '分机密码', - 'description' => '分机密码', - 'type' => 'string', - 'example' => 'a', - ], - 'ExtensionServer' => [ - 'title' => '分机注册地址', - 'description' => '分机注册地址', - 'type' => 'string', - 'example' => 'b', - ], - 'AgentId' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'c', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '43', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'TaskList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"Account\\": \\"a\\",\\n \\"WsRegisterAddress\\": \\"a\\",\\n \\"AgentExtension\\": 1,\\n \\"CreateTime\\": \\"2026-11-11 11:11:11\\",\\n \\"AgentGroupIds\\": [\\n 123\\n ],\\n \\"WsProtocol\\": \\"b\\",\\n \\"AgentGroupList\\": [\\n {\\n \\"GroupName\\": \\"a\\",\\n \\"GroupId\\": 1\\n }\\n ],\\n \\"Name\\": \\"b\\",\\n \\"Active\\": 1,\\n \\"AgentStatus\\": 1,\\n \\"ExtensionPwd\\": \\"a\\",\\n \\"ExtensionServer\\": \\"b\\",\\n \\"AgentId\\": 1,\\n \\"AgentTag\\": \\"c\\"\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 17,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AddAgentGroup' => [ - 'summary' => '创建坐席组接口', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskCallChats', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组名称，不能为空且最大长度为20个字符', - 'description' => '坐席组名称，不能为空且最大长度为20个字符', - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallChats', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AgentGroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'CreateTime' => [ - 'title' => '创建坐席组的时间', - 'description' => '创建坐席组的时间', - 'type' => 'string', - 'example' => '示例值', - ], - 'AgentGroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'UpdateTaskCustomer', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'aiccs:UpdateTaskCustomer', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"AgentGroupName\\": \\"example\\",\\n \\"CreateTime\\": \\"example\\",\\n \\"AgentGroupId\\": 48\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 40,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'JoinAgentGroup' => [ - 'summary' => '绑定坐席组', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'TaskCallList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TaskCallList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'SmsTemplatePageList', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '坐席ID列表', - 'description' => '坐席ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], - 'required' => true, - 'example' => '', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplatePageList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'AddTask', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 30,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'QuitAgentGroup' => [ - 'summary' => '解绑坐席组', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'Details', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '60', - ], - ], - [ - 'name' => 'AgentIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '坐席ID列表', - 'description' => '坐席ID列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席ID', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '111', - ], - 'required' => true, - 'example' => '', + 'ramAction' => [ + 'action' => 'aiccs:Details', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'Page', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:Page', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 15,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentGroupPage' => [ - 'summary' => '坐席组分页查询', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'EditTask', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'title' => '当前页', - 'description' => '当前页', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页数量', - 'description' => '分页数量', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'ramAction' => [ + 'action' => 'aiccs:EditTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'a', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '12345', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Pages' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '82', - ], - 'Size' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'Current' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62', - ], - 'Records' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AgentGroupName' => [ - 'title' => '坐席组名称', - 'description' => '坐席组名称', - 'type' => 'string', - 'example' => 'a', - ], - 'CreateTime' => [ - 'title' => '创建坐席组的时间', - 'description' => '创建坐席组的时间', - 'type' => 'string', - 'example' => '2026-01-01 11:11:11', - ], - 'AgentIds' => [ - 'title' => '坐席组下的坐席id列表', - 'description' => '坐席组下的坐席id列表', - 'type' => 'array', - 'items' => [ - 'title' => '坐席组下的坐席id', - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50022260', - ], - 'example' => '', - ], - 'AgentGroupId' => [ - 'title' => '坐席组ID', - 'description' => '坐席组ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '71', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'SmsTemplateCreate', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:SmsTemplateCreate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"a\\",\\n \\"RequestId\\": \\"12345\\",\\n \\"Model\\": {\\n \\"Pages\\": 82,\\n \\"Size\\": 15,\\n \\"Total\\": 12,\\n \\"Current\\": 62,\\n \\"Records\\": [\\n {\\n \\"AgentGroupName\\": \\"a\\",\\n \\"CreateTime\\": \\"2026-01-01 11:11:11\\",\\n \\"AgentIds\\": [\\n 50022260\\n ],\\n \\"AgentGroupId\\": 1\\n }\\n ]\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 71,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentCallList' => [ - 'summary' => '坐席外呼查询外呼记录', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ImportNumber', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID', - 'description' => '坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '51', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - ], - [ - 'name' => 'Numbers', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '号码列表', - 'description' => '号码列表', - 'type' => 'array', - 'items' => [ - 'title' => '号码', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '13541251222', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'NumberMD5s', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '号码MD5列表', - 'description' => '号码MD5列表', - 'type' => 'array', - 'items' => [ - 'title' => '号码MD5', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '用户自定义标签列表', - 'description' => '用户自定义标签列表', - 'type' => 'array', - 'items' => [ - 'title' => '用户自定义标签', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'tag1', - ], - 'required' => false, - 'example' => '', - ], - ], - [ - 'name' => 'CallDate', - 'in' => 'query', - 'schema' => [ - 'title' => '开始外呼时间', - 'description' => '开始外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2020-03-06 10:10:10', - ], - ], - [ - 'name' => 'EndCallDate', - 'in' => 'query', - 'schema' => [ - 'title' => '结束外呼时间', - 'description' => '结束外呼时间', - 'type' => 'string', - 'required' => true, - 'example' => '2020-03-07 10:10:10', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => '页数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '7', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '每页外呼记录数', - 'description' => '每页外呼记录数', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '14', + 'ramAction' => [ + 'action' => 'aiccs:ImportNumber', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '40', - ], - 'TotalPage' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '49', - ], - 'PageNo' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '44', - ], - 'List' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '外呼任务ID', - 'description' => '外呼任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentExtension' => [ - 'title' => '坐席分机', - 'description' => '坐席分机', - 'type' => 'string', - 'example' => 'a', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => '如链接,利息', - ], - 'CallType' => [ - 'title' => '可选项：1001：坐席-人工外呼，1002：坐席-AI外呼-不转人工，1003：坐席-AI外呼-接通转人工，1004：坐席-AI外呼-智能转人工；', - 'description' => '可选项：1001：坐席-人工外呼，1002：坐席-AI外呼-不转人工，1003：坐席-AI外呼-接通转人工，1004：坐席-AI外呼-智能转人工；', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - 'AnswerTime' => [ - 'title' => '接通时间 格式：2019-11-23 14:47:06', - 'description' => '接通时间 格式：2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'IntentTag' => [ - 'title' => '意向标签, 如“C”', - 'description' => '意向标签, 如“C”', - 'type' => 'string', - 'example' => 'C', - ], - 'TransferStatusCode' => [ - 'title' => '转人工状态编码', - 'description' => '转人工状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ImportTime' => [ - 'title' => '导入时间,格式：2019-11-23 14:47:06', - 'description' => '导入时间,格式：2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'IndividualTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => '如投诉,非本人', - ], - 'Properties' => [ - 'title' => '导入号码时的参数值', - 'description' => '导入号码时的参数值', - 'type' => 'string', - 'example' => '{"电话号码":"13100000000"}', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingDuration' => [ - 'title' => '坐席通话时长，单位：秒', - 'description' => '坐席通话时长，单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Remark' => [ - 'title' => '人工备注信息', - 'description' => '人工备注信息', - 'type' => 'string', - 'example' => 'abcd', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => '1', - ], - 'InterceptReason' => [ - 'title' => '拦截原因 当状态为已拦截时，可选值：黑名单拦截，灰名单拦截，异常号码拦截', - 'description' => '拦截原因 当状态为已拦截时，可选值：黑名单拦截，灰名单拦截，异常号码拦截', - 'type' => 'string', - 'example' => '黑名单拦截', - ], - 'IntentDescription' => [ - 'title' => '意向说明 如：确认本人,未承诺还款', - 'description' => '意向说明 如：确认本人,未承诺还款', - 'type' => 'string', - 'example' => '如：确认本人', - ], - 'StatusDescription' => [ - 'title' => '外呼状态，如“已接听”“拒接”，转外呼状态编码与描述对应 1-已接听,2-关机', - 'description' => '外呼状态，如“已接听”“拒接”，转外呼状态编码与描述对应 1-已接听,2-关机', - 'type' => 'string', - 'example' => '已接听', - ], - 'SpeakingDuration' => [ - 'title' => '通话时长 单位：秒', - 'description' => '通话时长 单位：秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TransferStatus' => [ - 'title' => '转人工状态 0-未触发', - 'description' => '转人工状态 0-未触发', - 'type' => 'string', - 'example' => '未触发', - ], - 'AgentId' => [ - 'title' => '分配坐席ID', - 'description' => '分配坐席ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'TemplateId' => [ - 'title' => 'AI话术ID', - 'description' => 'AI话术ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentTag' => [ - 'title' => '坐席标签', - 'description' => '坐席标签', - 'type' => 'string', - 'example' => 'a', - ], - 'BatchId' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'example' => '1', - ], - 'CallId' => [ - 'title' => '外呼ID', - 'description' => '外呼ID', - 'type' => 'string', - 'example' => '1', - ], - 'HangupTime' => [ - 'title' => '挂断时间 格式：2019-11-23 14:47:06', - 'description' => '挂断时间 格式：2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'CallBeginTime' => [ - 'title' => '开始通话时间, 格式：2019-11-23 14:47:06', - 'description' => '开始通话时间, 格式：2019-11-23 14:47:06', - 'type' => 'string', - 'example' => '2019-11-23 14:47:06', - ], - 'RingTime' => [ - 'title' => '振铃时长 单位：毫秒', - 'description' => '振铃时长 单位：毫秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AgentSpeakingTime' => [ - 'title' => '坐席通话时长，单位：大于1分钟，显示分钟秒，小于1分钟，显示秒', - 'description' => '坐席通话时长，单位：大于1分钟，显示分钟秒，小于1分钟，显示秒', - 'type' => 'string', - 'example' => '1', - ], - 'HangupType' => [ - 'title' => '挂机方式 AI挂机1，坐席挂机2，客户挂机3', - 'description' => '挂机方式 AI挂机1，坐席挂机2，客户挂机3', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SpeakingTurns' => [ - 'title' => '对话轮次', - 'description' => '对话轮次', - 'type' => 'string', - 'example' => '1', - ], - 'Sms' => [ - 'title' => '挂机短信 1:发送，2:不发送', - 'description' => '挂机短信 1:发送，2:不发送', - 'type' => 'string', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => '1', - ], - 'NumberMD5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => '1', - ], - 'ChatRecord' => [ - 'title' => '对话录音', - 'description' => '对话录音', - 'type' => 'string', - 'example' => 'URL', - ], - 'SpeakingTime' => [ - 'title' => '通话时长 单位：大于1分钟，显示分钟秒，小于1分钟，显示秒', - 'description' => '通话时长 单位：大于1分钟，显示分钟秒，小于1分钟，显示秒', - 'type' => 'string', - 'example' => '1', - ], - 'TransferTime' => [ - 'title' => '转接人工时间', - 'description' => '转接人工时间', - 'type' => 'string', - 'example' => '2019-01-09 14:14:19', - ], - ], - ], - 'example' => '', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '89', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + [ + 'apiName' => 'TemplateList', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'aiccs:TemplateList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"示例值\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Model\\": {\\n \\"TotalCount\\": 27,\\n \\"PageSize\\": 40,\\n \\"TotalPage\\": 49,\\n \\"PageNo\\": 44,\\n \\"List\\": [\\n {\\n \\"TaskId\\": 1,\\n \\"AgentExtension\\": \\"a\\",\\n \\"Keywords\\": \\"如链接,利息\\",\\n \\"CallType\\": 1001,\\n \\"AnswerTime\\": \\"2019-11-23 14:47:06\\",\\n \\"IntentTag\\": \\"C\\",\\n \\"TransferStatusCode\\": 0,\\n \\"ImportTime\\": \\"2019-11-23 14:47:06\\",\\n \\"IndividualTag\\": \\"如投诉,非本人\\",\\n \\"Properties\\": \\"{\\\\\\"电话号码\\\\\\":\\\\\\"13100000000\\\\\\"}\\",\\n \\"StatusCode\\": 1,\\n \\"AgentSpeakingDuration\\": 1,\\n \\"Remark\\": \\"abcd\\",\\n \\"Number\\": \\"1\\",\\n \\"InterceptReason\\": \\"黑名单拦截\\",\\n \\"IntentDescription\\": \\"如：确认本人\\",\\n \\"StatusDescription\\": \\"已接听\\",\\n \\"SpeakingDuration\\": 1,\\n \\"TransferStatus\\": \\"未触发\\",\\n \\"AgentId\\": 1,\\n \\"TemplateId\\": 1,\\n \\"AgentTag\\": \\"a\\",\\n \\"BatchId\\": \\"1\\",\\n \\"CallId\\": \\"1\\",\\n \\"HangupTime\\": \\"2019-11-23 14:47:06\\",\\n \\"CallBeginTime\\": \\"2019-11-23 14:47:06\\",\\n \\"RingTime\\": 1,\\n \\"AgentSpeakingTime\\": \\"1\\",\\n \\"HangupType\\": 1,\\n \\"SpeakingTurns\\": \\"1\\",\\n \\"Sms\\": \\"1\\",\\n \\"Tag\\": \\"1\\",\\n \\"NumberMD5\\": \\"1\\",\\n \\"ChatRecord\\": \\"URL\\",\\n \\"SpeakingTime\\": \\"1\\",\\n \\"TransferTime\\": \\"2019-01-09 14:14:19\\"\\n }\\n ]\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 89,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'AgentImportNumber' => [ - 'summary' => '坐席外呼导入号码', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TaskRecoverCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'OutId', - 'in' => 'query', - 'schema' => [ - 'title' => '请求id，具有唯一性，用来做请求幂等处理，一个请求id有效期10分钟。不传则不做幂等处理', - 'description' => '请求id，具有唯一性，用来做请求幂等处理，一个请求id有效期10分钟。不传则不做幂等处理', - 'type' => 'string', - 'required' => false, - 'example' => '1asgfh', - ], - ], - [ - 'name' => 'AgentId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席ID，可以为空，但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'description' => '坐席ID，可以为空，但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AgentTag', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席唯一标识（创建坐席时的用户唯一标识），可以为空，但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'description' => '坐席唯一标识（创建坐席时的用户唯一标识），可以为空，但agentId与agentTag必须其中1个有值。用于查询对应的坐席信息', - 'type' => 'string', - 'required' => false, - 'example' => '1001', - ], - ], - [ - 'name' => 'CallType', - 'in' => 'query', - 'schema' => [ - 'title' => '外呼类型 可选项：1001：坐席-人工外呼，1002：坐席-AI外呼-不转人工，1003：坐席-AI外呼-接通转人工，1004：坐席-AI外呼-智能转人工"', - 'description' => '外呼类型 可选项：1001：坐席-人工外呼，1002：坐席-AI外呼-不转人工，1003：坐席-AI外呼-接通转人工，1004：坐席-AI外呼-智能转人工"', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '79', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'query', - 'schema' => [ - 'title' => 'AI话术ID 客户已制作并已发布/平台授权的AI话术ID，如callType=1001可不填；如callType=1002,1003或1004 ，必填。', - 'description' => 'AI话术ID 客户已制作并已发布/平台授权的AI话术ID，如callType=1001可不填；如callType=1002,1003或1004 ，必填。', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'GatewayId', - 'in' => 'query', - 'schema' => [ - 'title' => '坐席-人工外呼选择的外呼线路，只针对callType=1001生效，其他callType不生效。如callType=1001，且gatewayId不传值，默认按系统的线路配置外呼', - 'description' => '坐席-人工外呼选择的外呼线路，只针对callType=1001生效，其他callType不生效。如callType=1001，且gatewayId不传值，默认按系统的线路配置外呼', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Customers', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '具体用户信息，如手机号、姓名等，需根据具体任务参数要求传输。注：当callType为1001时，只会导入第1条数据', - 'description' => '具体用户信息，如手机号、姓名等，需根据具体任务参数要求传输。注：当callType为1001时，只会导入第1条数据', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Number' => [ - 'title' => '号码，如手机号等', - 'description' => '号码，如手机号等', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'ClientUrl' => [ - 'title' => '客户详情URL,用于展示客户用户在客户业务系统的详细信息，做多80个字符', - 'description' => '客户详情URL,用于展示客户用户在客户业务系统的详细信息，做多80个字符', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Tag' => [ - 'title' => '用户自定义标签,最多50个字符', - 'description' => '用户自定义标签,最多50个字符', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'NumberMD5' => [ - 'title' => '用户电话号码MD5，和number两者必传一个', - 'description' => '用户电话号码MD5，和number两者必传一个', - 'type' => 'string', - 'required' => false, - 'example' => 'a', - ], - 'Properties' => [ - 'title' => '用户具体信息。如AI话术模板没变量要求或为人工外呼，可为空(总长度500个字符，多余的会被剔除)', - 'description' => '用户具体信息。如AI话术模板没变量要求或为人工外呼，可为空(总长度500个字符，多余的会被剔除)', - 'type' => 'object', - 'required' => false, - 'example' => '{"test":"234"}', - ], - ], - 'required' => false, - ], - 'required' => true, - 'example' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Access Denied', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BatchId' => [ - 'title' => '批次ID', - 'description' => '批次ID', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'Id' => [ - 'title' => '外呼编号ID', - 'description' => '外呼编号ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '80', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '93', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'false', - ], - ], + 'ramAction' => [ + 'action' => 'aiccs:TaskRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"Access Denied\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"BatchId\\": \\"example\\",\\n \\"Id\\": 80\\n },\\n \\"Code\\": \\"0\\",\\n \\"Timestamp\\": 93,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CallNumberDetail' => [ - 'summary' => '获取号码外呼详情', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdateAgentStatus', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '外呼编号ID', - 'description' => '外呼编号ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '95', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '33', + 'ramAction' => [ + 'action' => 'aiccs:UpdateAgentStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Keywords' => [ - 'title' => '回复关键词', - 'description' => '回复关键词', - 'type' => 'string', - 'example' => 'a', - ], - 'CallType' => [ - 'title' => '可选项 1-AI外呼，6-语音通知', - 'description' => '可选项 1-AI外呼，6-语音通知', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'IntentTag' => [ - 'title' => '意向标签', - 'description' => '意向标签', - 'type' => 'string', - 'example' => 'a', - ], - 'StatusCode' => [ - 'title' => '外呼状态编码', - 'description' => '外呼状态编码', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Remark' => [ - 'title' => '备注信息', - 'description' => '备注信息', - 'type' => 'string', - 'example' => 'a', - ], - 'Number' => [ - 'title' => '外呼号码', - 'description' => '外呼号码', - 'type' => 'string', - 'example' => 'a', - ], - 'TransferStatus' => [ - 'title' => '转人工状态 0-未触发,', - 'description' => '转人工状态 0-未触发,', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NumberMd5' => [ - 'title' => '外呼号码MD5', - 'description' => '外呼号码MD5', - 'type' => 'string', - 'example' => 'a', - ], - 'TemplateId' => [ - 'title' => '外呼使用的模板ID', - 'description' => '外呼使用的模板ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CallId' => [ - 'title' => '每次呼叫的唯一标识', - 'description' => '每次呼叫的唯一标识', - 'type' => 'string', - 'example' => 'a', - ], - 'BatchId' => [ - 'title' => '导入号码时返回的批次号', - 'description' => '导入号码时返回的批次号', - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '创建时间 格式 2026-01-01 00:00:00', - 'description' => '创建时间 格式 2026-01-01 00:00:00', - 'type' => 'string', - 'example' => '2026-01-01 00:00:00', - ], - 'Params' => [ - 'title' => '自定义参数 json', - 'description' => '自定义参数 json', - 'type' => 'string', - 'example' => '{"名字":"a"}', - ], - 'Duration' => [ - 'title' => '通话轮次', - 'description' => '通话轮次', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GatewayId' => [ - 'title' => '线路id', - 'description' => '线路id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AnswerTransferType' => [ - 'title' => '接通转接类型 1-不转人工；2-接通转人工；3-智能转人工', - 'description' => '接通转接类型 1-不转人工；2-接通转人工；3-智能转人工', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Sid' => [ - 'title' => '坐席id', - 'description' => '坐席id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BridgeBill' => [ - 'title' => '转接计费时长', - 'description' => '转接计费时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ClientUrl' => [ - 'title' => '客户详情url', - 'description' => '客户详情url', - 'type' => 'string', - 'example' => 'a', - ], - 'Bill' => [ - 'title' => '通话时长，单位为毫秒，实际计费需向上取整转换为秒', - 'description' => '通话时长，单位为毫秒，实际计费需向上取整转换为秒', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Id' => [ - 'title' => '号码编号', - 'description' => '号码编号', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Tag' => [ - 'title' => '用户自定义标签', - 'description' => '用户自定义标签', - 'type' => 'string', - 'example' => 'a', - ], - 'AiBill' => [ - 'title' => 'ai计费时长', - 'description' => 'ai计费时长', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PersonalityTag' => [ - 'title' => '个性标签', - 'description' => '个性标签', - 'type' => 'string', - 'example' => 'a', - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '48', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'AddBlacklist', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AddBlacklist', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": {\\n \\"TaskId\\": 1,\\n \\"Keywords\\": \\"a\\",\\n \\"CallType\\": 1,\\n \\"IntentTag\\": \\"a\\",\\n \\"StatusCode\\": 200,\\n \\"Remark\\": \\"a\\",\\n \\"Number\\": \\"a\\",\\n \\"TransferStatus\\": 0,\\n \\"NumberMd5\\": \\"a\\",\\n \\"TemplateId\\": 1,\\n \\"CallId\\": \\"a\\",\\n \\"BatchId\\": \\"1\\",\\n \\"CreateTime\\": \\"2026-01-01 00:00:00\\",\\n \\"Params\\": \\"{\\\\\\"名字\\\\\\":\\\\\\"a\\\\\\"}\\",\\n \\"Duration\\": 1,\\n \\"GatewayId\\": 1,\\n \\"AnswerTransferType\\": 1,\\n \\"Sid\\": 1,\\n \\"BridgeBill\\": 1,\\n \\"ClientUrl\\": \\"a\\",\\n \\"Bill\\": 1,\\n \\"Id\\": 1,\\n \\"Tag\\": \\"a\\",\\n \\"AiBill\\": 1,\\n \\"PersonalityTag\\": \\"a\\"\\n },\\n \\"Code\\": 0,\\n \\"Timestamp\\": 48,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - 'CallChatList' => [ - 'summary' => '获取聊天内容', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'AgentRecoverCall', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [ - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID', - 'description' => '任务ID', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'CallId', - 'in' => 'query', - 'schema' => [ - 'title' => 'callId', - 'description' => 'callId', - 'type' => 'string', - 'required' => false, - 'example' => 'a', + 'ramAction' => [ + 'action' => 'aiccs:AgentRecoverCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'AccessDeniedDetail' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'None', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值示例值示例值', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '示例值', - ], - 'Model' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'title' => '说话内容', - 'description' => '说话内容', - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'title' => '说话时间', - 'description' => '说话时间', - 'type' => 'string', - 'example' => '2019-01-09 14:14:19', - ], - 'FromType' => [ - 'title' => '说话号码，其中0为AI,1-用户,2-坐席', - 'description' => '说话号码，其中0为AI,1-用户,2-坐席', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4', - ], - 'ChatId' => [ - 'title' => '聊天内容id', - 'description' => '聊天内容id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '79', - ], - ], - ], - 'example' => '', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Timestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '81', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'AgentCancelCall', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'aiccs:AgentCancelCall', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'AICCS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"Message\\": \\"example\\",\\n \\"RequestId\\": \\"example\\",\\n \\"Model\\": [\\n {\\n \\"Content\\": \\"1\\",\\n \\"CreateTime\\": \\"2019-01-09 14:14:19\\",\\n \\"FromType\\": 0,\\n \\"ChatId\\": 79\\n }\\n ],\\n \\"Code\\": 0,\\n \\"Timestamp\\": 81,\\n \\"Success\\": true\\n}","type":"json"}]', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-nu16-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-edge-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-fujian', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-haidian-cm12-c01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-bj-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-prod-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-2', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-internal-test-3', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-test-306', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong-finance-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-north-2-gov-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao-nebula', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et15-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-et2-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-inner', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-internal-test-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-inner', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-st4-d01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-su18-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wuhan', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-yushanfang', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangbei-na61-b01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou-na62-a01', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-nebula-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1-oxs', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'rus-west-1-pop', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'aiccs.aliyuncs.com', - ], - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'aiccs.aliyuncs.com', ], + 'resourceTypes' => [], ], ]; |